ProcessOrder API


  • POST
    /4.3/Merchant/Merchant.svc
    Loads orders into TGC

Our ProcessOrder API enables the client to load orders into TGC Commerce by passing their chosen ship method along with the merchant's web order number.

Request (Y=Yes, N=No, C=Conditional, N/A=Not Applicable)


Authorization Required

To access this resources' endpoint you will need to provide your Username and Password provided to you by TGC in the ClientCredentials object.


ProcessOrder requests are supported by the SOAP POST method. The XML must conform to the following specifications:

Environment Protocol Host Path WSDL URL Format
Staging https:// services.filltekglobalsolutions.com /4.3/Merchant/Merchant.svc https://services.filltekglobalsolutions.com/4.3/Merchant/Merchant.svc?wsdl XML
Staging https:// services.filltekglobalsolutions.com /4.3/Merchant/MerchantWCF.svc (Preferred if using .NET) https://services.filltekglobalsolutions.com/4.3/Merchant/MerchantWCF.svc?wsdl XML
Production https:// services.tradeglobal.com /4.3/Merchant/Merchant.svc https://services.tradeglobal.com/4.3/Merchant/Merchant.svc?wsdl XML
Production https:// services.tradeglobal.com /4.3/Merchant/MerchantWCF.svc (Preferred if using .NET) https://services.tradeglobal.com/4.3/Merchant/MerchantWCF.svc?wsdl XML
Node Required Description Data Type Length Values
merchantCodeField Y Merchant Identifier assigned by TradeGlobal Commerce string 20
merchantOrderIdField Y Merchant's Web Order Number. This must be a unique value string 50
orderAttributesField N Deprecated. Pass as null Object
paymentInfoField N Deprecated. Pass as null Object
processPaymentField Y Indicates if payment is going to be processed. string 50 ALWAYS PASS VALUE OF None
quoteIdField Y Unique identifier retrieved from the GetQuote API response that indicates the chosen shipping method string 50 Must always be unique.
shipToAddressField C Ship To Address Information Object If left null, the ship to address from the chosen quote will be the assigned address
address1Field Y Ship From Address Line 1 String 50
address2Field N Ship From Address Line 2 String 50
cityField Y Ship From City String 50
countryField Y Ship To Country String 2 Must be a valid 2-character country code
emailField Y Ship To Email String 300
nameField Y Ship To Name Object
firstField Y First name of the customer string 50
middleField N Middle Name of the customer string 50
lastField Y Last Name of the customer string 50
phoneField Y Contact phone number of the customer string 50
postalCodeField Y Ship To Postal Code string 50 If there is no postal code for this destination, simply pass a whitespace or "NA"
stateProvinceField Y Ship To State/Province string 50 If no state/province exists, simply pass a whitespace or "NA"

Example Request - XML Format
POST /4.3/Merchant/Merchant.svc
HOST: services.tradeglobal.com
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:oas="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns="http://services.tradeglobal.com/2014/03" xmlns:trad="http://schemas.datacontract.org/2004/07/TradeGlobal.Common.Entities" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soapenv:Header>
      <oas:Security>
         <oas:UsernameToken>
            <oas:Password>XXXXXXXXXX</oas:Password>
            <oas:Username>XXXXXXXXXX</oas:Username>
         </oas:UsernameToken>
      </oas:Security>
   </soapenv:Header>
   <soapenv:Body>
      <ns:ProcessOrder>
         <!--Optional:-->
         <ns:order>
            <trad:merchantCodeField>TGCSANDBOX</trad:merchantCodeField>
            <trad:merchantOrderIdField>TESTORDER001</trad:merchantOrderIdField>
            <trad:orderAttributesField xsi:nil='true'>
               <!--Zero or more repetitions:-->
               <trad:OrderAttribute>
                  <trad:nameField>?</trad:nameField>
                  <trad:typeField>?</trad:typeField>
                  <trad:valueField>
                     <!--Zero or more repetitions:-->
                     <arr:string>?</arr:string>
                  </trad:valueField>
               </trad:OrderAttribute>
            </trad:orderAttributesField>
            <trad:paymentInfoField xsi:nil='true'>
               <trad:accountField>
                  <trad:expMonthField>?</trad:expMonthField>
                  <trad:expYearField>?</trad:expYearField>
                  <trad:fullNameField>?</trad:fullNameField>
                  <trad:idField>?</trad:idField>
                  <trad:securityCodeField>?</trad:securityCodeField>
               </trad:accountField>
               <trad:amountField>?</trad:amountField>
               <trad:billingAddressField>
                  <trad:address1Field>?</trad:address1Field>
                  <trad:address2Field>?</trad:address2Field>
                  <trad:cityField>?</trad:cityField>
                  <trad:countryField>?</trad:countryField>
                  <trad:emailField>?</trad:emailField>
                  <trad:nameField>
                     <trad:firstField>?</trad:firstField>
                     <trad:lastField>?</trad:lastField>
                     <trad:middleField>?</trad:middleField>
                  </trad:nameField>
                  <trad:phoneField>?</trad:phoneField>
                  <trad:postalCodeField>?</trad:postalCodeField>
                  <trad:stateProvinceField>?</trad:stateProvinceField>
               </trad:billingAddressField>
               <trad:buyCurrencyField>?</trad:buyCurrencyField>
               <trad:creditAmountField>?</trad:creditAmountField>
               <trad:currencyField>?</trad:currencyField>
               <trad:cyberSourceField>
                  <trad:fraudCheckAttributesField>
                     <trad:aVSCodeField>?</trad:aVSCodeField>
                     <trad:bankInformationField>
                        <trad:countryField>?</trad:countryField>
                        <trad:nameField>?</trad:nameField>
                     </trad:bankInformationField>
                     <trad:browserEmailField>?</trad:browserEmailField>
                     <trad:byPassFraudCheckField>?</trad:byPassFraudCheckField>
                     <trad:cVCodeField>?</trad:cVCodeField>
                     <trad:customRiskModelField>?</trad:customRiskModelField>
                     <trad:customerIDField>?</trad:customerIDField>
                     <trad:hostNameField>?</trad:hostNameField>
                     <trad:iPAddressField>?</trad:iPAddressField>
                  </trad:fraudCheckAttributesField>
               </trad:cyberSourceField>
               <trad:goInterPayField>
                  <trad:buyCurrencyField>?</trad:buyCurrencyField>
                  <trad:countryCodeField>?</trad:countryCodeField>
                  <trad:emailField>?</trad:emailField>
                  <trad:ipField>?</trad:ipField>
                  <trad:openContractField>?</trad:openContractField>
                  <trad:postalCodeField>?</trad:postalCodeField>
                  <trad:rateOfferIDField>?</trad:rateOfferIDField>
                  <trad:referenceIDField>?</trad:referenceIDField>
               </trad:goInterPayField>
               <trad:merchantCodeField>?</trad:merchantCodeField>
               <trad:merchantField>
                  <trad:idField>?</trad:idField>
                  <trad:refCodeField>?</trad:refCodeField>
               </trad:merchantField>
               <trad:paymentIDField>?</trad:paymentIDField>
               <trad:paymentProcessorField>?</trad:paymentProcessorField>
               <trad:typeField>?</trad:typeField>
            </trad:paymentInfoField>
            <trad:processPaymentField>None</trad:processPaymentField>
            <trad:quoteIdField>a8cd2841-25d5-49c2-b6af-3a5681acfb6a</trad:quoteIdField>
            <trad:shipToAddressField xsi:nil='true'>
               <trad:address1Field>123 Main Street</trad:address1Field>
               <trad:address2Field xsi:nil='true'>?</trad:address2Field>
               <trad:cityField>Toronto</trad:cityField>
               <trad:countryField>CA</trad:countryField>
               <trad:emailField>test@tgc.com</trad:emailField>
               <trad:nameField>
                  <trad:firstField>Bryan</trad:firstField>
                  <trad:lastField>testcase</trad:lastField>
                  <trad:middleField xsi:nil='true'>?</trad:middleField>
               </trad:nameField>
               <trad:phoneField>555555555</trad:phoneField>
               <trad:postalCodeField>M5S 2A2</trad:postalCodeField>
               <trad:stateProvinceField>ON</trad:stateProvinceField>
            </trad:shipToAddressField>
         </ns:order>
      </ns:ProcessOrder>
   </soapenv:Body>
</soapenv:Envelope>


Response

If the request is valid and authorized, the server will process the request and return a response. The response will return a ProcessOrderResponse object. None of the data returned is necessary as these fields are used for payment processing, which is no longer support by this API

Output Elements (Y=Yes, N=No, C=Conditional, N/A=Not Applicable)

Node Required Description Data Type Length Values
orderIdField N Web order number that was passed in the request string 50
paymentResponseField N Payment Response Object Object NO LONGER SUPPORTED
returnCodeField N No longer support. Will always be null Object
returnDescField N No longer support. Will always be N/A as payment processing is no longer support with this API string 10
Example Respone - XML Format
200 OK
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <ProcessOrderResponse xmlns="http://services.tradeglobal.com/2014/03">
         <ProcessOrderResult xmlns:a="http://schemas.datacontract.org/2004/07/TradeGlobal.Common.Entities" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:orderIdField>TestOrder001</a:orderIdField>
            <a:paymentResponseField i:nil="true"/>
            <a:returnCodeField i:nil="true"/>
            <a:returnDescField>N/A</a:returnDescField>
         </ProcessOrderResult>
      </ProcessOrderResponse>
   </s:Body>
</s:Envelope>


Try it Yourself

You can test out this API by viewing our Product Demo