OrderManagement Web Service

OrderManagement

Click here for a complete list of operations.

CreateOrderAcknowledgement

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/CreateOrderAcknowledgement"

<?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>
    <CreateOrderAcknowledgement 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>
      <purchaseOrderAcknowledgement>
        <Id>int</Id>
        <AcknowledgedBySupplier>boolean</AcknowledgedBySupplier>
        <ReceivedBySupplier>dateTime</ReceivedBySupplier>
        <SupplierResponse>string</SupplierResponse>
        <SupplierUniqueMessageID>guid</SupplierUniqueMessageID>
        <BuyerAbn>string</BuyerAbn>
        <BillToAccountNumber>string</BillToAccountNumber>
        <DeliveryAccountNumber>string</DeliveryAccountNumber>
        <Reference>string</Reference>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <LineCount>int</LineCount>
        <DocumentMode>int</DocumentMode>
        <Lines>
          <PurchaseOrderAcknowledgmentLine>
            <OrderLineUID>guid</OrderLineUID>
            <ReorderNumber>string</ReorderNumber>
            <EAN>string</EAN>
            <Description>string</Description>
            <QuantityOrdered>int</QuantityOrdered>
            <QuantityBackordered>int</QuantityBackordered>
            <QuantityOutOfStock>int</QuantityOutOfStock>
            <UOM>string</UOM>
            <UnitCostexGST>double</UnitCostexGST>
            <ETA>dateTime</ETA>
            <Warehouse>string</Warehouse>
            <WarehouseRole>string</WarehouseRole>
            <Message>string</Message>
          </PurchaseOrderAcknowledgmentLine>
          <PurchaseOrderAcknowledgmentLine>
            <OrderLineUID>guid</OrderLineUID>
            <ReorderNumber>string</ReorderNumber>
            <EAN>string</EAN>
            <Description>string</Description>
            <QuantityOrdered>int</QuantityOrdered>
            <QuantityBackordered>int</QuantityBackordered>
            <QuantityOutOfStock>int</QuantityOutOfStock>
            <UOM>string</UOM>
            <UnitCostexGST>double</UnitCostexGST>
            <ETA>dateTime</ETA>
            <Warehouse>string</Warehouse>
            <WarehouseRole>string</WarehouseRole>
            <Message>string</Message>
          </PurchaseOrderAcknowledgmentLine>
        </Lines>
      </purchaseOrderAcknowledgement>
    </CreateOrderAcknowledgement>
  </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>
    <CreateOrderAcknowledgementResponse xmlns="http://www.pharmx.com.au/gateway3/ordermanagement">
      <CreateOrderAcknowledgementResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </CreateOrderAcknowledgementResult>
    </CreateOrderAcknowledgementResponse>
  </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>
    <CreateOrderAcknowledgement 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>
      <purchaseOrderAcknowledgement>
        <Id>int</Id>
        <AcknowledgedBySupplier>boolean</AcknowledgedBySupplier>
        <ReceivedBySupplier>dateTime</ReceivedBySupplier>
        <SupplierResponse>string</SupplierResponse>
        <SupplierUniqueMessageID>guid</SupplierUniqueMessageID>
        <BuyerAbn>string</BuyerAbn>
        <BillToAccountNumber>string</BillToAccountNumber>
        <DeliveryAccountNumber>string</DeliveryAccountNumber>
        <Reference>string</Reference>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <LineCount>int</LineCount>
        <DocumentMode>int</DocumentMode>
        <Lines>
          <PurchaseOrderAcknowledgmentLine>
            <OrderLineUID>guid</OrderLineUID>
            <ReorderNumber>string</ReorderNumber>
            <EAN>string</EAN>
            <Description>string</Description>
            <QuantityOrdered>int</QuantityOrdered>
            <QuantityBackordered>int</QuantityBackordered>
            <QuantityOutOfStock>int</QuantityOutOfStock>
            <UOM>string</UOM>
            <UnitCostexGST>double</UnitCostexGST>
            <ETA>dateTime</ETA>
            <Warehouse>string</Warehouse>
            <WarehouseRole>string</WarehouseRole>
            <Message>string</Message>
          </PurchaseOrderAcknowledgmentLine>
          <PurchaseOrderAcknowledgmentLine>
            <OrderLineUID>guid</OrderLineUID>
            <ReorderNumber>string</ReorderNumber>
            <EAN>string</EAN>
            <Description>string</Description>
            <QuantityOrdered>int</QuantityOrdered>
            <QuantityBackordered>int</QuantityBackordered>
            <QuantityOutOfStock>int</QuantityOutOfStock>
            <UOM>string</UOM>
            <UnitCostexGST>double</UnitCostexGST>
            <ETA>dateTime</ETA>
            <Warehouse>string</Warehouse>
            <WarehouseRole>string</WarehouseRole>
            <Message>string</Message>
          </PurchaseOrderAcknowledgmentLine>
        </Lines>
      </purchaseOrderAcknowledgement>
    </CreateOrderAcknowledgement>
  </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>
    <CreateOrderAcknowledgementResponse xmlns="http://www.pharmx.com.au/gateway3/ordermanagement">
      <CreateOrderAcknowledgementResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </CreateOrderAcknowledgementResult>
    </CreateOrderAcknowledgementResponse>
  </soap12:Body>
</soap12:Envelope>