POST api/freightwarewaybillcreate/create

Creates operational shipment waybills in FreightWare including consignor details, consignee information, parcel item lines, dimensions, weights, routing information, service types and delivery instructions.

Request Information

URI Parameters

None.

Body Parameters

FWWaybillRequest

Name	Description	Type	Additional information
Waybills		Collection of FWWaybillShipment	None.
Items		Collection of FWWaybillItem	None.

Request Formats

application/json, text/json

Sample:

{
  "Waybills": [
    {
      "waybillNumber": "sample string 1",
      "waybillDate": "sample string 2",
      "accountReference": "sample string 3",
      "shipperReference": "sample string 4",
      "serviceType": "sample string 5",
      "consignmentValue": 6.1,
      "insuredAmount": 7.1,
      "numberOfItems": "sample string 8",
      "comments": "sample string 9",
      "consignorName": "sample string 10",
      "consignorStreet": "sample string 11",
      "consignorSuburb": "sample string 12",
      "consignorCity": "sample string 13",
      "consignorPostalCode": "sample string 14",
      "consignorContactName": "sample string 15",
      "consignorContactTel": "sample string 16",
      "consigneeName": "sample string 17",
      "consigneeStreet": "sample string 18",
      "consigneeSuburb": "sample string 19",
      "consigneeCity": "sample string 20",
      "consigneePostalCode": "sample string 21",
      "consigneeContactName": "sample string 22",
      "consigneeContactTel": "sample string 23",
      "deliveryInstructions": "sample string 24"
    },
    {
      "waybillNumber": "sample string 1",
      "waybillDate": "sample string 2",
      "accountReference": "sample string 3",
      "shipperReference": "sample string 4",
      "serviceType": "sample string 5",
      "consignmentValue": 6.1,
      "insuredAmount": 7.1,
      "numberOfItems": "sample string 8",
      "comments": "sample string 9",
      "consignorName": "sample string 10",
      "consignorStreet": "sample string 11",
      "consignorSuburb": "sample string 12",
      "consignorCity": "sample string 13",
      "consignorPostalCode": "sample string 14",
      "consignorContactName": "sample string 15",
      "consignorContactTel": "sample string 16",
      "consigneeName": "sample string 17",
      "consigneeStreet": "sample string 18",
      "consigneeSuburb": "sample string 19",
      "consigneeCity": "sample string 20",
      "consigneePostalCode": "sample string 21",
      "consigneeContactName": "sample string 22",
      "consigneeContactTel": "sample string 23",
      "deliveryInstructions": "sample string 24"
    }
  ],
  "Items": [
    {
      "waybillNumber": "sample string 1",
      "lineNumber": 2,
      "quantity": 3,
      "waybillItemObj": 4,
      "productCode": "sample string 5",
      "description": "sample string 6",
      "totalWeight": 7.1,
      "length": 8.1,
      "width": 9.1,
      "height": 10.1,
      "rateTypeCode": "sample string 11"
    },
    {
      "waybillNumber": "sample string 1",
      "lineNumber": 2,
      "quantity": 3,
      "waybillItemObj": 4,
      "productCode": "sample string 5",
      "description": "sample string 6",
      "totalWeight": 7.1,
      "length": 8.1,
      "width": 9.1,
      "height": 10.1,
      "rateTypeCode": "sample string 11"
    }
  ]
}

application/xml, text/xml

Sample:

<FWWaybillRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DCB_API">
  <Items>
    <FWWaybillItem>
      <description>sample string 6</description>
      <height>10.1</height>
      <length>8.1</length>
      <lineNumber>2</lineNumber>
      <productCode>sample string 5</productCode>
      <quantity>3</quantity>
      <rateTypeCode>sample string 11</rateTypeCode>
      <totalWeight>7.1</totalWeight>
      <waybillItemObj>4</waybillItemObj>
      <waybillNumber>sample string 1</waybillNumber>
      <width>9.1</width>
    </FWWaybillItem>
    <FWWaybillItem>
      <description>sample string 6</description>
      <height>10.1</height>
      <length>8.1</length>
      <lineNumber>2</lineNumber>
      <productCode>sample string 5</productCode>
      <quantity>3</quantity>
      <rateTypeCode>sample string 11</rateTypeCode>
      <totalWeight>7.1</totalWeight>
      <waybillItemObj>4</waybillItemObj>
      <waybillNumber>sample string 1</waybillNumber>
      <width>9.1</width>
    </FWWaybillItem>
  </Items>
  <Waybills>
    <FWWaybillShipment>
      <accountReference>sample string 3</accountReference>
      <comments>sample string 9</comments>
      <consigneeCity>sample string 20</consigneeCity>
      <consigneeContactName>sample string 22</consigneeContactName>
      <consigneeContactTel>sample string 23</consigneeContactTel>
      <consigneeName>sample string 17</consigneeName>
      <consigneePostalCode>sample string 21</consigneePostalCode>
      <consigneeStreet>sample string 18</consigneeStreet>
      <consigneeSuburb>sample string 19</consigneeSuburb>
      <consignmentValue>6.1</consignmentValue>
      <consignorCity>sample string 13</consignorCity>
      <consignorContactName>sample string 15</consignorContactName>
      <consignorContactTel>sample string 16</consignorContactTel>
      <consignorName>sample string 10</consignorName>
      <consignorPostalCode>sample string 14</consignorPostalCode>
      <consignorStreet>sample string 11</consignorStreet>
      <consignorSuburb>sample string 12</consignorSuburb>
      <deliveryInstructions>sample string 24</deliveryInstructions>
      <insuredAmount>7.1</insuredAmount>
      <numberOfItems>sample string 8</numberOfItems>
      <serviceType>sample string 5</serviceType>
      <shipperReference>sample string 4</shipperReference>
      <waybillDate>sample string 2</waybillDate>
      <waybillNumber>sample string 1</waybillNumber>
    </FWWaybillShipment>
    <FWWaybillShipment>
      <accountReference>sample string 3</accountReference>
      <comments>sample string 9</comments>
      <consigneeCity>sample string 20</consigneeCity>
      <consigneeContactName>sample string 22</consigneeContactName>
      <consigneeContactTel>sample string 23</consigneeContactTel>
      <consigneeName>sample string 17</consigneeName>
      <consigneePostalCode>sample string 21</consigneePostalCode>
      <consigneeStreet>sample string 18</consigneeStreet>
      <consigneeSuburb>sample string 19</consigneeSuburb>
      <consignmentValue>6.1</consignmentValue>
      <consignorCity>sample string 13</consignorCity>
      <consignorContactName>sample string 15</consignorContactName>
      <consignorContactTel>sample string 16</consignorContactTel>
      <consignorName>sample string 10</consignorName>
      <consignorPostalCode>sample string 14</consignorPostalCode>
      <consignorStreet>sample string 11</consignorStreet>
      <consignorSuburb>sample string 12</consignorSuburb>
      <deliveryInstructions>sample string 24</deliveryInstructions>
      <insuredAmount>7.1</insuredAmount>
      <numberOfItems>sample string 8</numberOfItems>
      <serviceType>sample string 5</serviceType>
      <shipperReference>sample string 4</shipperReference>
      <waybillDate>sample string 2</waybillDate>
      <waybillNumber>sample string 1</waybillNumber>
    </FWWaybillShipment>
  </Waybills>
</FWWaybillRequest>

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

Response Information

Resource Description

FWWaybillResponse

Name	Type	Additional 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:

<FWWaybillResponse 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>
</FWWaybillResponse>