Mark Order Acknowledged

Definition

Service Location: https://gateway.pharmx.com.au/Gateway3/OrderManagement.asmx

Confirms the successful receipt of a PurchaseOrder, returned from RetrieveOrders. This method should be called for each order received.

Parameters

userDetail UserDetail
User credentials to authenticate the request.

orderID int
PharmX ID of the Order being acknowledged.

received Datetime
The datetime the order was processed by the supplier system.

supplierMessage string
Message to be returned to the client. If no message is provided, this value will default to (e.g. “Order Acknowleged”)

acknowledgementType int (not currently used)
0, order received successfully

Returns

MarkOrderAcknowledgedResult ActionResult (with an array of GatewayOrderAcknowledgments)

Samples

MarkOrderAcknowledged Request

XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ord="http://www.pharmx.com.au/gateway3/ordermanagement">
  <soapenv:Header/>
  <soapenv:Body>
    <ord:MarkOrderAcknowledged>
      <ord:userDetail>
        <ord:Username>your username</ord:Username>
        <ord:Password>your password</ord:Password>
        <ord:ApplicationId>0</ord:ApplicationId>
        <ord:ApplicationVersionNumber>0</ord:ApplicationVersionNumber>
        <ord:Extension1/>
        <ord:Extension2/>
      </ord:userDetail>
      <ord:orderId>150053141</ord:orderId>
      <ord:received>2019-01-07T14:00:00.000+11:00</ord:received>
      <ord:supplierMessage>Order received</ord:supplierMessage>
      <ord:acknowledgementType>0</ord:acknowledgementType>
    </ord:MarkOrderAcknowledged>
  </soapenv:Body>
</soapenv:Envelope>

MarkOrderAcknowledged Response

XML

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema ">
  <soap:Body>
    <MarkOrderAcknowledgedResponse xmlns="http://www.pharmx.com.au/gateway3/ordermanagement">
      <MarkOrderAcknowledgedResult>
        <Success>true</Success>
        <ResultCode>0</ResultCode>
        <Message/>
        <DocumentCount>1</DocumentCount>
        <Documents>
          <DocumentType xsi:type="GatewayOrderAcknowledgment">
            <Id>150053141</Id>
            <AcknowledgedBySupplier>true</AcknowledgedBySupplier>
            <ReceivedBySupplier>2019-01-07T03:00:00Z</ReceivedBySupplier>
            <Status>Sent</Status>
            <SupplierResponse>Order received</SupplierResponse>
            <Created>2018-12-11T01:45:06Z</Created>
            <Sent>2019-01-07T04:43:30Z</Sent>
            <BuyerAbn/>
            <BillToAccountNumber>2281Ph1</BillToAccountNumber>
            <DeliveryAccountNumber>2281Ph1</DeliveryAccountNumber>
            <Reference>G2PhC001</Reference>
            <SupplierId>123</SupplierId>
            <StateSupplierId>123</StateSupplierId>
            <LineCount>3</LineCount>
            <DocumentMode>0</DocumentMode>
            <InterfaceVersion>2</InterfaceVersion>
            <ExtendedInfos>
              <ExtendedInfo>
                <Name/>
                <Type>string</Type>
                <Value/>
              </ExtendedInfo>
            </ExtendedInfos>
            <Lines/>
          </DocumentType>
        </Documents>
      </MarkOrderAcknowledgedResult>
    </MarkOrderAcknowledgedResponse>
  </soap:Body>
</soap:Envelope>