POST api/DCBOnlineWaybillSave

Enterprise transactional draft-save endpoint for the DCB OMS/TMS platform. This endpoint: • Validates incoming shipment data • Creates destination delivery sites • Saves draft waybills • Saves parcel information • Saves invoice references • Preserves operational shipment snapshots • Uses SQL transactional commit/rollback protection Current functionality: • Draft save only • No FreightWare push • No label generation • No parcel allocation • No finalization workflow The endpoint automatically: • Calculates shipment totals • Calculates volumetric weights • Calculates invoice totals • Creates destination site records • Links sites to company ownership structures Route: POST /api/DCBOnlineWaybillSave Required: • companyId • accountNumber • waybillNumber • divisionId • serviceTypeId • parcels Returns: • success status • saved waybill ID • waybill number • validation errors if applicable

Request Information

URI Parameters

None.

Body Parameters

DCBOnlineWaybillSaveRequest

Name	Type	Additional information
WaybillNumber	string	None.
AccountNumber	string	None.
DivisionId	integer	None.
CompanyId	integer	None.
ServiceTypeId	integer	None.
CustomerReferenceNumber	string	None.
SpecialInstructions	string	None.
Remarks	string	None.
CreatedByUserFullName	string	None.
InsuranceValue	decimal number	None.
SiteId	integer	None.
SiteName	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
Suburb	string	None.
City	string	None.
DestHub	string	None.
PostalCode	string	None.
DestRouteCode	string	None.
ContactPerson	string	None.
ContactNumber	string	None.
EmailAddress	string	None.
ChainStore	boolean	None.
AfterHours	boolean	None.
PublicHoliday	boolean	None.
Saterday	boolean	None.
Farm	boolean	None.
IncompatibleSurcharges	boolean	None.
Plant	boolean	None.
MinesPlotsTownships	boolean	None.
Parcels	Collection of DCBOnlineWaybillParcelRequest	None.
InvoiceReferences	Collection of DCBOnlineWaybillInvoiceReferenceRequest	None.

Request Formats

application/json, text/json

Sample:

{
  "WaybillNumber": "sample string 1",
  "AccountNumber": "sample string 2",
  "DivisionId": 3,
  "CompanyId": 4,
  "ServiceTypeId": 5,
  "CustomerReferenceNumber": "sample string 6",
  "SpecialInstructions": "sample string 7",
  "Remarks": "sample string 8",
  "CreatedByUserFullName": "sample string 9",
  "InsuranceValue": 10.0,
  "SiteId": 1,
  "SiteName": "sample string 11",
  "AddressLine1": "sample string 12",
  "AddressLine2": "sample string 13",
  "Suburb": "sample string 14",
  "City": "sample string 15",
  "DestHub": "sample string 16",
  "PostalCode": "sample string 17",
  "DestRouteCode": "sample string 18",
  "ContactPerson": "sample string 19",
  "ContactNumber": "sample string 20",
  "EmailAddress": "sample string 21",
  "ChainStore": true,
  "AfterHours": true,
  "PublicHoliday": true,
  "Saterday": true,
  "Farm": true,
  "IncompatibleSurcharges": true,
  "Plant": true,
  "MinesPlotsTownships": true,
  "Parcels": [
    {
      "Quantity": 1,
      "Description": "sample string 2",
      "Length": 3.0,
      "Breadth": 4.0,
      "Height": 5.0,
      "Mass": 6.0,
      "PackageType": "sample string 7",
      "RateType": "sample string 8",
      "LoadType": "sample string 9"
    },
    {
      "Quantity": 1,
      "Description": "sample string 2",
      "Length": 3.0,
      "Breadth": 4.0,
      "Height": 5.0,
      "Mass": 6.0,
      "PackageType": "sample string 7",
      "RateType": "sample string 8",
      "LoadType": "sample string 9"
    }
  ],
  "InvoiceReferences": [
    {
      "InvoiceNo": "sample string 1",
      "InvDescription": "sample string 2",
      "InvUnit": "sample string 3",
      "InvValue": 4.0
    },
    {
      "InvoiceNo": "sample string 1",
      "InvDescription": "sample string 2",
      "InvUnit": "sample string 3",
      "InvValue": 4.0
    }
  ]
}

application/xml, text/xml

Sample:

<DCBOnlineWaybillSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DCB_API">
  <AccountNumber>sample string 2</AccountNumber>
  <AddressLine1>sample string 12</AddressLine1>
  <AddressLine2>sample string 13</AddressLine2>
  <AfterHours>true</AfterHours>
  <ChainStore>true</ChainStore>
  <City>sample string 15</City>
  <CompanyId>4</CompanyId>
  <ContactNumber>sample string 20</ContactNumber>
  <ContactPerson>sample string 19</ContactPerson>
  <CreatedByUserFullName>sample string 9</CreatedByUserFullName>
  <CustomerReferenceNumber>sample string 6</CustomerReferenceNumber>
  <DestHub>sample string 16</DestHub>
  <DestRouteCode>sample string 18</DestRouteCode>
  <DivisionId>3</DivisionId>
  <EmailAddress>sample string 21</EmailAddress>
  <Farm>true</Farm>
  <IncompatibleSurcharges>true</IncompatibleSurcharges>
  <InsuranceValue>10</InsuranceValue>
  <InvoiceReferences>
    <DCBOnlineWaybillInvoiceReferenceRequest>
      <InvDescription>sample string 2</InvDescription>
      <InvUnit>sample string 3</InvUnit>
      <InvValue>4</InvValue>
      <InvoiceNo>sample string 1</InvoiceNo>
    </DCBOnlineWaybillInvoiceReferenceRequest>
    <DCBOnlineWaybillInvoiceReferenceRequest>
      <InvDescription>sample string 2</InvDescription>
      <InvUnit>sample string 3</InvUnit>
      <InvValue>4</InvValue>
      <InvoiceNo>sample string 1</InvoiceNo>
    </DCBOnlineWaybillInvoiceReferenceRequest>
  </InvoiceReferences>
  <MinesPlotsTownships>true</MinesPlotsTownships>
  <Parcels>
    <DCBOnlineWaybillParcelRequest>
      <Breadth>4</Breadth>
      <Description>sample string 2</Description>
      <Height>5</Height>
      <Length>3</Length>
      <LoadType>sample string 9</LoadType>
      <Mass>6</Mass>
      <PackageType>sample string 7</PackageType>
      <Quantity>1</Quantity>
      <RateType>sample string 8</RateType>
    </DCBOnlineWaybillParcelRequest>
    <DCBOnlineWaybillParcelRequest>
      <Breadth>4</Breadth>
      <Description>sample string 2</Description>
      <Height>5</Height>
      <Length>3</Length>
      <LoadType>sample string 9</LoadType>
      <Mass>6</Mass>
      <PackageType>sample string 7</PackageType>
      <Quantity>1</Quantity>
      <RateType>sample string 8</RateType>
    </DCBOnlineWaybillParcelRequest>
  </Parcels>
  <Plant>true</Plant>
  <PostalCode>sample string 17</PostalCode>
  <PublicHoliday>true</PublicHoliday>
  <Remarks>sample string 8</Remarks>
  <Saterday>true</Saterday>
  <ServiceTypeId>5</ServiceTypeId>
  <SiteId>1</SiteId>
  <SiteName>sample string 11</SiteName>
  <SpecialInstructions>sample string 7</SpecialInstructions>
  <Suburb>sample string 14</Suburb>
  <WaybillNumber>sample string 1</WaybillNumber>
</DCBOnlineWaybillSaveRequest>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.