WCService Web Service

WCService

Click here for a complete list of operations.

getOrder2_0

Returns the order details for the provided order number. Version 2 includes invoice information and BOL comments when applicable.
Error Codes Returned: G0001, BO018

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /WCService.asmx HTTP/1.1
Host: webservice.westerncarriers.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www3.westerncarriers.com/Webservices/getOrder2_0"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SecurityHeader xmlns="https://www3.westerncarriers.com/Webservices">
      <AuthenticationKey>string</AuthenticationKey>
    </SecurityHeader>
  </soap:Header>
  <soap:Body>
    <getOrder2_0 xmlns="https://www3.westerncarriers.com/Webservices">
      <pOrderNumber>string</pOrderNumber>
    </getOrder2_0>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getOrder2_0Response xmlns="https://www3.westerncarriers.com/Webservices">
      <getOrder2_0Result>
        <Comments>
          <BOLNum>string</BOLNum>
          <EndComments>
            <string>string</string>
            <string>string</string>
          </EndComments>
          <HeadComments>
            <string>string</string>
            <string>string</string>
          </HeadComments>
          <lines>
            <bolcomdet xsi:nil="true" />
            <bolcomdet xsi:nil="true" />
          </lines>
        </Comments>
        <DeliveryStatusInfo>
          <ActualArrivalDateAndTime>dateTime</ActualArrivalDateAndTime>
          <ActualDepartureDateAndTime>dateTime</ActualDepartureDateAndTime>
          <MinutesDelayed>int</MinutesDelayed>
          <OrderIsDelivered>boolean</OrderIsDelivered>
          <DeliveryStatusText>string</DeliveryStatusText>
          <RouteId>string</RouteId>
          <_upsItems>
            <UPSItem xsi:nil="true" />
            <UPSItem xsi:nil="true" />
          </_upsItems>
        </DeliveryStatusInfo>
        <Items>
          <OrderItem>
            <Bottles>int</Bottles>
            <Cases>int</Cases>
            <TaxStatus>string</TaxStatus>
            <Lot>string</Lot>
            <TransactionType>string</TransactionType>
            <Weight>int</Weight>
            <Comment>string</Comment>
            <StateCode>string</StateCode>
          </OrderItem>
          <OrderItem>
            <Bottles>int</Bottles>
            <Cases>int</Cases>
            <TaxStatus>string</TaxStatus>
            <Lot>string</Lot>
            <TransactionType>string</TransactionType>
            <Weight>int</Weight>
            <Comment>string</Comment>
            <StateCode>string</StateCode>
          </OrderItem>
        </Items>
        <MiscCharges>
          <InvoiceMiscCharge>
            <ChargeAmount>decimal</ChargeAmount>
            <ChargeDescription>string</ChargeDescription>
          </InvoiceMiscCharge>
          <InvoiceMiscCharge>
            <ChargeAmount>decimal</ChargeAmount>
            <ChargeDescription>string</ChargeDescription>
          </InvoiceMiscCharge>
        </MiscCharges>
        <OrderHeader>
          <Date_entered>dateTime</Date_entered>
          <Date_shipped>dateTime</Date_shipped>
          <OrderStatus>string</OrderStatus>
          <PlannedArrivalTime>string</PlannedArrivalTime>
          <ActualArrivalTime>string</ActualArrivalTime>
        </OrderHeader>
      </getOrder2_0Result>
    </getOrder2_0Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /WCService.asmx HTTP/1.1
Host: webservice.westerncarriers.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <SecurityHeader xmlns="https://www3.westerncarriers.com/Webservices">
      <AuthenticationKey>string</AuthenticationKey>
    </SecurityHeader>
  </soap12:Header>
  <soap12:Body>
    <getOrder2_0 xmlns="https://www3.westerncarriers.com/Webservices">
      <pOrderNumber>string</pOrderNumber>
    </getOrder2_0>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getOrder2_0Response xmlns="https://www3.westerncarriers.com/Webservices">
      <getOrder2_0Result>
        <Comments>
          <BOLNum>string</BOLNum>
          <EndComments>
            <string>string</string>
            <string>string</string>
          </EndComments>
          <HeadComments>
            <string>string</string>
            <string>string</string>
          </HeadComments>
          <lines>
            <bolcomdet xsi:nil="true" />
            <bolcomdet xsi:nil="true" />
          </lines>
        </Comments>
        <DeliveryStatusInfo>
          <ActualArrivalDateAndTime>dateTime</ActualArrivalDateAndTime>
          <ActualDepartureDateAndTime>dateTime</ActualDepartureDateAndTime>
          <MinutesDelayed>int</MinutesDelayed>
          <OrderIsDelivered>boolean</OrderIsDelivered>
          <DeliveryStatusText>string</DeliveryStatusText>
          <RouteId>string</RouteId>
          <_upsItems>
            <UPSItem xsi:nil="true" />
            <UPSItem xsi:nil="true" />
          </_upsItems>
        </DeliveryStatusInfo>
        <Items>
          <OrderItem>
            <Bottles>int</Bottles>
            <Cases>int</Cases>
            <TaxStatus>string</TaxStatus>
            <Lot>string</Lot>
            <TransactionType>string</TransactionType>
            <Weight>int</Weight>
            <Comment>string</Comment>
            <StateCode>string</StateCode>
          </OrderItem>
          <OrderItem>
            <Bottles>int</Bottles>
            <Cases>int</Cases>
            <TaxStatus>string</TaxStatus>
            <Lot>string</Lot>
            <TransactionType>string</TransactionType>
            <Weight>int</Weight>
            <Comment>string</Comment>
            <StateCode>string</StateCode>
          </OrderItem>
        </Items>
        <MiscCharges>
          <InvoiceMiscCharge>
            <ChargeAmount>decimal</ChargeAmount>
            <ChargeDescription>string</ChargeDescription>
          </InvoiceMiscCharge>
          <InvoiceMiscCharge>
            <ChargeAmount>decimal</ChargeAmount>
            <ChargeDescription>string</ChargeDescription>
          </InvoiceMiscCharge>
        </MiscCharges>
        <OrderHeader>
          <Date_entered>dateTime</Date_entered>
          <Date_shipped>dateTime</Date_shipped>
          <OrderStatus>string</OrderStatus>
          <PlannedArrivalTime>string</PlannedArrivalTime>
          <ActualArrivalTime>string</ActualArrivalTime>
        </OrderHeader>
      </getOrder2_0Result>
    </getOrder2_0Response>
  </soap12:Body>
</soap12:Envelope>