POST SCSDespatch/orders/addOrder

Adds order to despatch request queue for processing

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Order		TBL_DispatchRequest_Caddy_HDR	None.
Lines		Collection of TBL_DispatchRequest_Caddy_Lines	None.

Request Formats

application/json, text/json

Sample:

{
  "Order": {
    "ID": "4d1aba52-939e-4910-9e6a-81d9d94d0f82",
    "RecordType": "sample string 2",
    "ClientOrderNumber": "sample string 3",
    "DealerOrder": "sample string 4",
    "ClientReference": "sample string 5",
    "CustomerOrderNumber": "sample string 6",
    "ConsigneeCode": "sample string 7",
    "DeliveryName": "sample string 8",
    "DeliveryAddress1": "sample string 9",
    "DeliveryAddress2": "sample string 10",
    "DeliveryAddress3": "sample string 11",
    "DeliveryInstructions": "sample string 12",
    "InvoiceName": "sample string 13",
    "InvoiceAddress1": "sample string 14",
    "InvoiceAddress2": "sample string 15",
    "InvoiceAddress3": "sample string 16",
    "InvoiceContact": "sample string 17",
    "WarehouseCode": "sample string 18",
    "RepCode": "sample string 19",
    "RepName": "sample string 20",
    "DateOrdered": "2026-10-12T20:40:11.9445422+13:00",
    "DateRequired": "2026-10-12T20:40:11.9445422+13:00",
    "DateDispatched": "2026-10-12T20:40:11.9445422+13:00",
    "DeliveryCountryCodeNo": "sample string 21",
    "ConsigneePostCode": "sample string 22",
    "MiscellaneousChargesTotal": 1.0,
    "FreightCharge": 1.0,
    "GST": 1.0,
    "Comment1": "sample string 23",
    "Comment2": "sample string 24",
    "Comment3": "sample string 25",
    "Unused": 1.0,
    "Pallets": 1,
    "Weight": 1.0,
    "Volume": 1.0,
    "NetInvoice": 1.0,
    "CarrierDescription": "sample string 26",
    "CarrierConsNoteRef": "sample string 27",
    "DistributorConsNoteRef": "sample string 28",
    "SAPIDOCNO": "sample string 29",
    "DeliveryCity": "sample string 30",
    "DeliverySuburb": "sample string 31",
    "Priority": 32,
    "AdvertisedDate": "2026-10-12T20:40:11.9445422+13:00",
    "LineCount": 1,
    "DeliveryState": "sample string 33",
    "DeliveryCountryCodeAlpha": "sample string 34",
    "CarrierServiceRequired": "sample string 35",
    "PrefixSSCC": true,
    "ShipmentCredit": true,
    "ClientOrderType": "sample string 36",
    "VASIndicators": "sample string 37",
    "DeliveryPhoneNumber": "sample string 38",
    "Status": "sample string 41"
  },
  "Lines": [
    {
      "ID": "e95af55d-9864-4b74-bfab-52ad963ba4ae",
      "HdrID": "QEA=",
      "RecordType": "sample string 2",
      "ClientOrderNumber": "sample string 3",
      "ClientLineNumber": 1,
      "Unused": "sample string 4",
      "ClientReference": "sample string 5",
      "ProductCode": "sample string 6",
      "ProductDescription": "sample string 7",
      "ProductSpecies": "sample string 8",
      "QuantityOrdered": 9.0,
      "QuantityDelivered": 1.0,
      "UnitRecommendedRRP": 1.0,
      "UnitDiscount": 1.0,
      "UnitPrice": 1.0,
      "ExtendedPrice": 1.0,
      "MicellaneousChargeDescription": "sample string 10",
      "MiscellaneousChrageAmount": 1.0,
      "BatchNumber": "sample string 11",
      "SerialNumber": "sample string 12",
      "PackTypeOrdered": "sample string 13",
      "UnitWeight": 1.0,
      "UnitVolume": 1.0,
      "Grade1": "sample string 14",
      "Grade2": "sample string 15",
      "Grade3": "sample string 16",
      "Notes": "sample string 17",
      "SpecificationNumber": "sample string 18",
      "CaseNumber": "sample string 19",
      "EcertNumber": "sample string 20",
      "ShiptoStoreCode": "sample string 21",
      "ShipToStoreDept": "sample string 22",
      "ShipToAddress1": "sample string 23",
      "ShipToAddress2": "sample string 24",
      "ShipToAddress3": "sample string 25",
      "ShipToAddress4": "sample string 26",
      "AlternateUnitPrice": 1.0,
      "VASIndicators": 1.0
    },
    {
      "ID": "e95af55d-9864-4b74-bfab-52ad963ba4ae",
      "HdrID": "QEA=",
      "RecordType": "sample string 2",
      "ClientOrderNumber": "sample string 3",
      "ClientLineNumber": 1,
      "Unused": "sample string 4",
      "ClientReference": "sample string 5",
      "ProductCode": "sample string 6",
      "ProductDescription": "sample string 7",
      "ProductSpecies": "sample string 8",
      "QuantityOrdered": 9.0,
      "QuantityDelivered": 1.0,
      "UnitRecommendedRRP": 1.0,
      "UnitDiscount": 1.0,
      "UnitPrice": 1.0,
      "ExtendedPrice": 1.0,
      "MicellaneousChargeDescription": "sample string 10",
      "MiscellaneousChrageAmount": 1.0,
      "BatchNumber": "sample string 11",
      "SerialNumber": "sample string 12",
      "PackTypeOrdered": "sample string 13",
      "UnitWeight": 1.0,
      "UnitVolume": 1.0,
      "Grade1": "sample string 14",
      "Grade2": "sample string 15",
      "Grade3": "sample string 16",
      "Notes": "sample string 17",
      "SpecificationNumber": "sample string 18",
      "CaseNumber": "sample string 19",
      "EcertNumber": "sample string 20",
      "ShiptoStoreCode": "sample string 21",
      "ShipToStoreDept": "sample string 22",
      "ShipToAddress1": "sample string 23",
      "ShipToAddress2": "sample string 24",
      "ShipToAddress3": "sample string 25",
      "ShipToAddress4": "sample string 26",
      "AlternateUnitPrice": 1.0,
      "VASIndicators": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<DespatchOrderPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SCSInwardsPortal.Models">
  <Lines>
    <TBL_DispatchRequest_Caddy_Lines>
      <AlternateUnitPrice>1</AlternateUnitPrice>
      <BatchNumber>sample string 11</BatchNumber>
      <CaseNumber>sample string 19</CaseNumber>
      <ClientLineNumber>1</ClientLineNumber>
      <ClientOrderNumber>sample string 3</ClientOrderNumber>
      <ClientReference>sample string 5</ClientReference>
      <EcertNumber>sample string 20</EcertNumber>
      <ExtendedPrice>1</ExtendedPrice>
      <Grade1>sample string 14</Grade1>
      <Grade2>sample string 15</Grade2>
      <Grade3>sample string 16</Grade3>
      <HdrID>QEA=</HdrID>
      <ID>e95af55d-9864-4b74-bfab-52ad963ba4ae</ID>
      <MicellaneousChargeDescription>sample string 10</MicellaneousChargeDescription>
      <MiscellaneousChrageAmount>1</MiscellaneousChrageAmount>
      <Notes>sample string 17</Notes>
      <PackTypeOrdered>sample string 13</PackTypeOrdered>
      <ProductCode>sample string 6</ProductCode>
      <ProductDescription>sample string 7</ProductDescription>
      <ProductID>sample string 27</ProductID>
      <ProductSpecies>sample string 8</ProductSpecies>
      <QuantityDelivered>1</QuantityDelivered>
      <QuantityOrdered>9</QuantityOrdered>
      <RecordType>sample string 2</RecordType>
      <SerialNumber>sample string 12</SerialNumber>
      <ShipToAddress1>sample string 23</ShipToAddress1>
      <ShipToAddress2>sample string 24</ShipToAddress2>
      <ShipToAddress3>sample string 25</ShipToAddress3>
      <ShipToAddress4>sample string 26</ShipToAddress4>
      <ShipToStoreDept>sample string 22</ShipToStoreDept>
      <ShiptoStoreCode>sample string 21</ShiptoStoreCode>
      <SpecificationNumber>sample string 18</SpecificationNumber>
      <Status>sample string 28</Status>
      <UnitDiscount>1</UnitDiscount>
      <UnitPrice>1</UnitPrice>
      <UnitRecommendedRRP>1</UnitRecommendedRRP>
      <UnitVolume>1</UnitVolume>
      <UnitWeight>1</UnitWeight>
      <Unused>sample string 4</Unused>
      <VASIndicators>1</VASIndicators>
    </TBL_DispatchRequest_Caddy_Lines>
    <TBL_DispatchRequest_Caddy_Lines>
      <AlternateUnitPrice>1</AlternateUnitPrice>
      <BatchNumber>sample string 11</BatchNumber>
      <CaseNumber>sample string 19</CaseNumber>
      <ClientLineNumber>1</ClientLineNumber>
      <ClientOrderNumber>sample string 3</ClientOrderNumber>
      <ClientReference>sample string 5</ClientReference>
      <EcertNumber>sample string 20</EcertNumber>
      <ExtendedPrice>1</ExtendedPrice>
      <Grade1>sample string 14</Grade1>
      <Grade2>sample string 15</Grade2>
      <Grade3>sample string 16</Grade3>
      <HdrID>QEA=</HdrID>
      <ID>e95af55d-9864-4b74-bfab-52ad963ba4ae</ID>
      <MicellaneousChargeDescription>sample string 10</MicellaneousChargeDescription>
      <MiscellaneousChrageAmount>1</MiscellaneousChrageAmount>
      <Notes>sample string 17</Notes>
      <PackTypeOrdered>sample string 13</PackTypeOrdered>
      <ProductCode>sample string 6</ProductCode>
      <ProductDescription>sample string 7</ProductDescription>
      <ProductID>sample string 27</ProductID>
      <ProductSpecies>sample string 8</ProductSpecies>
      <QuantityDelivered>1</QuantityDelivered>
      <QuantityOrdered>9</QuantityOrdered>
      <RecordType>sample string 2</RecordType>
      <SerialNumber>sample string 12</SerialNumber>
      <ShipToAddress1>sample string 23</ShipToAddress1>
      <ShipToAddress2>sample string 24</ShipToAddress2>
      <ShipToAddress3>sample string 25</ShipToAddress3>
      <ShipToAddress4>sample string 26</ShipToAddress4>
      <ShipToStoreDept>sample string 22</ShipToStoreDept>
      <ShiptoStoreCode>sample string 21</ShiptoStoreCode>
      <SpecificationNumber>sample string 18</SpecificationNumber>
      <Status>sample string 28</Status>
      <UnitDiscount>1</UnitDiscount>
      <UnitPrice>1</UnitPrice>
      <UnitRecommendedRRP>1</UnitRecommendedRRP>
      <UnitVolume>1</UnitVolume>
      <UnitWeight>1</UnitWeight>
      <Unused>sample string 4</Unused>
      <VASIndicators>1</VASIndicators>
    </TBL_DispatchRequest_Caddy_Lines>
  </Lines>
  <Order>
    <AccountCode>sample string 42</AccountCode>
    <AccountEdiExtension>sample string 44</AccountEdiExtension>
    <AccountKey>sample string 43</AccountKey>
    <AdvertisedDate>2026-10-12T20:40:11.9445422+13:00</AdvertisedDate>
    <CarrierConsNoteRef>sample string 27</CarrierConsNoteRef>
    <CarrierDescription>sample string 26</CarrierDescription>
    <CarrierServiceRequired>sample string 35</CarrierServiceRequired>
    <ClientOrderNumber>sample string 3</ClientOrderNumber>
    <ClientOrderType>sample string 36</ClientOrderType>
    <ClientReference>sample string 5</ClientReference>
    <Comment1>sample string 23</Comment1>
    <Comment2>sample string 24</Comment2>
    <Comment3>sample string 25</Comment3>
    <ConsigneeCode>sample string 7</ConsigneeCode>
    <ConsigneePostCode>sample string 22</ConsigneePostCode>
    <CustomerOrderNumber>sample string 6</CustomerOrderNumber>
    <DTCreated>2026-10-12T20:40:11.9445422+13:00</DTCreated>
    <DTExported>2026-10-12T20:40:11.9445422+13:00</DTExported>
    <DateDispatched>2026-10-12T20:40:11.9445422+13:00</DateDispatched>
    <DateOrdered>2026-10-12T20:40:11.9445422+13:00</DateOrdered>
    <DateRequired>2026-10-12T20:40:11.9445422+13:00</DateRequired>
    <DealerOrder>sample string 4</DealerOrder>
    <DeliveryAddress1>sample string 9</DeliveryAddress1>
    <DeliveryAddress2>sample string 10</DeliveryAddress2>
    <DeliveryAddress3>sample string 11</DeliveryAddress3>
    <DeliveryCity>sample string 30</DeliveryCity>
    <DeliveryCountryCodeAlpha>sample string 34</DeliveryCountryCodeAlpha>
    <DeliveryCountryCodeNo>sample string 21</DeliveryCountryCodeNo>
    <DeliveryInstructions>sample string 12</DeliveryInstructions>
    <DeliveryName>sample string 8</DeliveryName>
    <DeliveryPhoneNumber>sample string 38</DeliveryPhoneNumber>
    <DeliveryState>sample string 33</DeliveryState>
    <DeliverySuburb>sample string 31</DeliverySuburb>
    <DistributorConsNoteRef>sample string 28</DistributorConsNoteRef>
    <ExportType>sample string 40</ExportType>
    <FreightCharge>1</FreightCharge>
    <GST>1</GST>
    <ID>4d1aba52-939e-4910-9e6a-81d9d94d0f82</ID>
    <InvoiceAddress1>sample string 14</InvoiceAddress1>
    <InvoiceAddress2>sample string 15</InvoiceAddress2>
    <InvoiceAddress3>sample string 16</InvoiceAddress3>
    <InvoiceContact>sample string 17</InvoiceContact>
    <InvoiceName>sample string 13</InvoiceName>
    <LineCount>1</LineCount>
    <MiscellaneousChargesTotal>1</MiscellaneousChargesTotal>
    <NetInvoice>1</NetInvoice>
    <Pallets>1</Pallets>
    <PrefixSSCC>true</PrefixSSCC>
    <Priority>32</Priority>
    <RecordType>sample string 2</RecordType>
    <RepCode>sample string 19</RepCode>
    <RepName>sample string 20</RepName>
    <SAPIDOCNO>sample string 29</SAPIDOCNO>
    <ShipmentCredit>true</ShipmentCredit>
    <Status>sample string 41</Status>
    <Unused>1</Unused>
    <VASIndicators>sample string 37</VASIndicators>
    <Volume>1</Volume>
    <WarehouseCode>sample string 18</WarehouseCode>
    <Weight>1</Weight>
  </Order>
</DespatchOrderPostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.