API/Services/PurchaseProduct - Revision history

Dcowan: added createimmediateinvoice notes

2019-05-02T07:32:46Z

added createimmediateinvoice notes

Rlusher at 00:19, 22 November 2018

2018-11-22T00:19:06Z

Scarpenter at 01:10, 13 June 2018

2018-06-13T01:10:48Z

Show changes

Scarpenter: /* Purchase Product */

2018-03-26T00:07:19Z

‎Purchase Product

FMahmood at 02:41, 22 June 2016

2016-06-22T02:41:10Z

FMahmood: /* Purchase Product */

2016-06-22T02:28:32Z

‎Purchase Product

Jlee: /* Purchase Product */

2014-09-10T06:47:26Z

‎Purchase Product

Jlee: /* Purchase Product */

2014-09-10T06:47:09Z

‎Purchase Product

Jlee: /* Purchase Product */

2014-09-10T06:46:58Z

‎Purchase Product

Jlee: /* Purchase Product */

2014-09-10T06:46:18Z

‎Purchase Product

@@ Line 6: / Line 6: @@
 '''Inputs'''
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api" xmlns:urn1="urn:emersion:types">
     <soapenv:Header/>
@@ Line 16: / Line 17: @@
                 <urn1:ProductID>?</urn1:ProductID>
                 <urn1:Quantity>?</urn1:Quantity>
                 <urn1:ExTaxPrice>?</urn1:ExTaxPrice>
                 <urn1:Tax>?</urn1:Tax>
                 <urn1:Note_Details>?</urn1:Note_Details>
                 <urn1:Note_Customer_Visible>?</urn1:Note_Customer_Visible>
              </urn1:PurchaseItem>
           </urn:ShoppingCart>
           <urn:DeliveryAddress>
              <urn1:PrimaryAddressID>?</urn1:PrimaryAddressID>
              <urn1:Address ID="?">
                 <urn1:IsPrimary>?</urn1:IsPrimary>
                 <urn1:Details/>
                 <urn1:NearestCrossStreet>?</urn1:NearestCrossStreet>
                 <urn1:Country>?</urn1:Country>
                 <urn1:FormattedAddress>?</urn1:FormattedAddress>
                 <urn1:IsValidated>?</urn1:IsValidated>
                 <urn1:Type>?</urn1:Type>
                 <urn1:DateFrom>?</urn1:DateFrom>
                 <urn1:DateTo>?</urn1:DateTo>
                 <urn1:GnafPid ID="?">?</urn1:GnafPid>
                 <urn1:DPID>?</urn1:DPID>
                 <urn1:Barcode>?</urn1:Barcode>
                 <urn1:ExternalReferences>
                    <!--Zero or more repetitions:-->
                    <urn1:ExternalReference Type="?">?</urn1:ExternalReference>
                 </urn1:ExternalReferences>
                 <urn1:UploadSource>?</urn1:UploadSource>
                 <urn1:UploadSourceRef>?</urn1:UploadSourceRef>
                 <urn1:ImportIdentifier>?</urn1:ImportIdentifier>
                 <urn1:LastUpdated>?</urn1:LastUpdated>
              </urn1:Address>
           </urn:DeliveryAddress>
        </urn:PurchaseProducts>
     </soapenv:Body>
 </soapenv:Envelope>
 '''Important notes'''
--	ProductID needs to be the ID of the Product in the Emersion system
+* ''ProductID'' needs to be the ID of the Product in the Emersion system
--	Quantity has to be non-zero and an integer
+* ''Quantity'' has to be non-zero and an integer
--	ExTaxPrice and Tax are floating point numbers however tax is optional – a sale can be tax free.
+* ''ExTaxPrice'' and Tax are floating point numbers however tax is optional – a sale can be tax free.
 '''Example Validation Error'''

@@ Line 3: / Line 3: @@
 '''Purpose'''
 This method is used to create a product purchase on behalf of an existing client. This call supports creating pending cardline items for charging to next invoice.
 '''Inputs'''

@@ Line 18: / Line 18: @@
                 <!--Optional:-->
                 <ser:Tax>9</ser:Tax>
              </ser:PurchaseItem>
           </ser:ShoppingCart>

@@ Line 70: / Line 70: @@
-'''Error String'''
+'''Error Strings'''
-.	Invalid or Missing Account ID
+* Invalid or Missing Account ID
-.	Could not find Account ID!
+* Could not find Account ID!
-.	You do not have permission to modify this Account!
+* You do not have permission to modify this Account!
-.	No items have been provided to purchase in transaction.
+* No items have been provided to purchase in transaction.
-.	Cart item missing mandatory ProductID
+* Cart item missing mandatory ProductID
-.	Cart item missing mandatory quantity
+* Cart item missing mandatory quantity
-.	Product purchase failed with an exception: '.$e->getMessage());
+* Product purchase failed with an exception: '.$e->getMessage());

@@ Line 5: / Line 5: @@
 '''Inputs'''
    <soapenv:Header/>
-   <xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://emersion.com.au/ServiceObjects">
+   <soapenv:Body>
-    <soapenv:Header/>
+      <ser:PurchaseProducts>
-    <soapenv:Body>
+         <ser:AccountID>9999999</ser:AccountID>
-	<ser:PurchaseProducts>
+         <ser:ShoppingCart>
-	<ser:AccountID>?</ser:AccountID>
+            <!--1 to 999 repetitions:-->
-	  <ser:ShoppingCart>
+            <ser:PurchaseItem>
-	  <!--1 to 999 repetitions:-->
+               <ser:ProductID>9999999</ser:ProductID>
-	  <ser:PurchaseItem>
+               <ser:Quantity>9</ser:Quantity>
-	  <ser:ProductID>?</ser:ProductID>
+               <!--Optional:-->
-	  <ser:Quantity>?</ser:Quantity>
+               <ser:ExTaxPrice>99</ser:ExTaxPrice>
-	  <!--Optional:-->
+               <!--Optional:-->
-	    <ser:ExTaxPrice>?</ser:ExTaxPrice>
+               <ser:Tax>9</ser:Tax>
-	    <!--Optional:-->
+            </ser:PurchaseItem>
-	  <ser:Tax>?</ser:Tax>
+         </ser:ShoppingCart>
-	</ser:PurchaseItem>
+         <!--Optional:-->
-      </ser:ShoppingCart>
+         <ser:DeliveryAddress>
-     </ser:PurchaseProducts>
+            <!--Optional:-->
     </soapenv:Body>