OrderManagement Web Service

OrderManagement

Click here for a complete list of operations.

CheckOrderCompliance

Check Order Compliance

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 /Gateway3/OrderManagement.asmx HTTP/1.1
Host: gateway.pharmx.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.pharmx.com.au/gateway3/ordermanagement/CheckOrderCompliance"

<?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>
    <CheckOrderCompliance xmlns="http://www.pharmx.com.au/gateway3/ordermanagement">
      <userDetail>
        <Username>string</Username>
        <Password>string</Password>
        <ApplicationId>int</ApplicationId>
        <ApplicationVersionNumber>int</ApplicationVersionNumber>
        <Extension1>string</Extension1>
        <Extension2>string</Extension2>
      </userDetail>
      <po>
        <BuyerAbn>string</BuyerAbn>
        <BillToAccountNumber>string</BillToAccountNumber>
        <DeliveryAccountNumber>string</DeliveryAccountNumber>
        <Purchaser>string</Purchaser>
        <PurchaserSignature>string</PurchaserSignature>
        <Backup>string</Backup>
        <Code>string</Code>
        <DeliverNoEarlierThan>dateTime</DeliverNoEarlierThan>
        <DeliverNoLaterThan>dateTime</DeliverNoLaterThan>
        <Group>string</Group>
        <Method>string</Method>
        <Reference>string</Reference>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <Type>string</Type>
        <LineCount>int</LineCount>
        <Freight>unsignedByte</Freight>
        <POSuniqueMessageID>guid</POSuniqueMessageID>
        <Lines>
          <PurchaseOrderLine>
            <OrderLineUID>guid</OrderLineUID>
            <ReorderNumber>string</ReorderNumber>
            <EAN>string</EAN>
            <Description>string</Description>
            <QuantityOrdered>int</QuantityOrdered>
            <UOM>string</UOM>
            <UnitCostexGST>double</UnitCostexGST>
          </PurchaseOrderLine>
          <PurchaseOrderLine>
            <OrderLineUID>guid</OrderLineUID>
            <ReorderNumber>string</ReorderNumber>
            <EAN>string</EAN>
            <Description>string</Description>
            <QuantityOrdered>int</QuantityOrdered>
            <UOM>string</UOM>
            <UnitCostexGST>double</UnitCostexGST>
          </PurchaseOrderLine>
        </Lines>
      </po>
    </CheckOrderCompliance>
  </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>
    <CheckOrderComplianceResponse xmlns="http://www.pharmx.com.au/gateway3/ordermanagement">
      <CheckOrderComplianceResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </CheckOrderComplianceResult>
    </CheckOrderComplianceResponse>
  </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 /Gateway3/OrderManagement.asmx HTTP/1.1
Host: gateway.pharmx.com.au
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>
    <CheckOrderCompliance xmlns="http://www.pharmx.com.au/gateway3/ordermanagement">
      <userDetail>
        <Username>string</Username>
        <Password>string</Password>
        <ApplicationId>int</ApplicationId>
        <ApplicationVersionNumber>int</ApplicationVersionNumber>
        <Extension1>string</Extension1>
        <Extension2>string</Extension2>
      </userDetail>
      <po>
        <BuyerAbn>string</BuyerAbn>
        <BillToAccountNumber>string</BillToAccountNumber>
        <DeliveryAccountNumber>string</DeliveryAccountNumber>
        <Purchaser>string</Purchaser>
        <PurchaserSignature>string</PurchaserSignature>
        <Backup>string</Backup>
        <Code>string</Code>
        <DeliverNoEarlierThan>dateTime</DeliverNoEarlierThan>
        <DeliverNoLaterThan>dateTime</DeliverNoLaterThan>
        <Group>string</Group>
        <Method>string</Method>
        <Reference>string</Reference>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <Type>string</Type>
        <LineCount>int</LineCount>
        <Freight>unsignedByte</Freight>
        <POSuniqueMessageID>guid</POSuniqueMessageID>
        <Lines>
          <PurchaseOrderLine>
            <OrderLineUID>guid</OrderLineUID>
            <ReorderNumber>string</ReorderNumber>
            <EAN>string</EAN>
            <Description>string</Description>
            <QuantityOrdered>int</QuantityOrdered>
            <UOM>string</UOM>
            <UnitCostexGST>double</UnitCostexGST>
          </PurchaseOrderLine>
          <PurchaseOrderLine>
            <OrderLineUID>guid</OrderLineUID>
            <ReorderNumber>string</ReorderNumber>
            <EAN>string</EAN>
            <Description>string</Description>
            <QuantityOrdered>int</QuantityOrdered>
            <UOM>string</UOM>
            <UnitCostexGST>double</UnitCostexGST>
          </PurchaseOrderLine>
        </Lines>
      </po>
    </CheckOrderCompliance>
  </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>
    <CheckOrderComplianceResponse xmlns="http://www.pharmx.com.au/gateway3/ordermanagement">
      <CheckOrderComplianceResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </CheckOrderComplianceResult>
    </CheckOrderComplianceResponse>
  </soap12:Body>
</soap12:Envelope>