GFS Developer Portal

Examples

GetCheckoutOrder request example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:gfs="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Request" xmlns:gfs1="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Partial" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:gfs2="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Enumerations">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ProcessCheckoutOrder>
         <tem:processCheckoutOrderReqeust>
            <gfs:DateRange>
               <gfs1:DateFrom>2016-11-01</gfs1:DateFrom>
               <gfs1:DateTo>2016-12-10</gfs1:DateTo>
            </gfs:DateRange>
            <gfs:Order>
               <gfs1:Transit>
                  <gfs1:Recipient>
                     <gfs1:Location>
                        <gfs1:CountryCode>
                           <gfs1:Code>GB</gfs1:Code>
                           <gfs1:Encoding>ccISO_3166_1_Alpha2</gfs1:Encoding>
                        </gfs1:CountryCode>
                        <gfs1:Postcode>NN5 8RU</gfs1:Postcode>
                     </gfs1:Location>
                  </gfs1:Recipient>
               </gfs1:Transit>
               <gfs1:Value>
                  <gfs1:CurrencyCode>GBP</gfs1:CurrencyCode>
                  <gfs1:Value>45</gfs1:Value>
               </gfs1:Value>
            </gfs:Order>
            <gfs:RequestedDeliveryTypes>
               <gfs2:DeliveryMethodEnumeration>dmDropPoint</gfs2:DeliveryMethodEnumeration>
               <gfs2:DeliveryMethodEnumeration>dmStandard</gfs2:DeliveryMethodEnumeration>
               <gfs2:DeliveryMethodEnumeration>dmStore</gfs2:DeliveryMethodEnumeration>
            </gfs:RequestedDeliveryTypes>
            <gfs:Session>
               <gfs1:APIKeyID>YOUR_API_KEY_HERE</gfs1:APIKeyID>
            </gfs:Session>
         </tem:processCheckoutOrderReqeust>
      </tem:ProcessCheckoutOrder>
   </soapenv:Body>
</soapenv:Envelope>

CloseCheckout Request example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:gfs="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Request" xmlns:gfs1="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Partial" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:gfs2="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Enumerations">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:CloseCheckout>
         <tem:closeCheckoutRequest>
            <gfs:SelectedSuperservice>
               <gfs1:DeliveryOptionId>D1S2</gfs1:DeliveryOptionId>
            </gfs:SelectedSuperservice>
            <gfs:Session>
               <gfs1:APIKeyID>API_KEY_HERE</gfs1:APIKeyID>
               <gfs1:SessionID>7baa473f-1158-4262-9d71-9a487cf94643</gfs1:SessionID>
            </gfs:Session>
         </tem:closeCheckoutRequest>
      </tem:CloseCheckout>
   </soapenv:Body>
</soapenv:Envelope>

Closing a 'dmStandardDroppint' type service

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:gfs="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Request" xmlns:gfs1="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Partial" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:gfs2="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Enumerations">
      <tem:CloseCheckout>
         <tem:closeCheckoutRequest>
           <gfs:SelectedDropPoint>
               <gfs1:DropPointID>GB12255</gfs1:DropPointID>
               <gfs1:DropPointProviderID>4</gfs1:DropPointProviderID>
            </gfs:SelectedDropPoint>
            <gfs:SelectedSuperservice>
               <gfs1:DeliveryOptionId>D0S0</gfs1:DeliveryOptionId>
            </gfs:SelectedSuperservice>
            <gfs:Session>
               <gfs1:APIKeyID>API_KEY_HERE</gfs1:APIKeyID>
               <gfs1:SessionID>7baa473f-1158-4262-9d71-9a487cf94643</gfs1:SessionID>
            </gfs:Session>
         </tem:closeCheckoutRequest>
      </tem:CloseCheckout>
  </soapenv:Body>
</soapenv:Envelope>

Closing a ‘dmStandardStore’ type service

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:gfs="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Request" xmlns:gfs1="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Partial" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:gfs2="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Enumerations">
<tem:CloseCheckout>
         <tem:closeCheckoutRequest>
<gfs:SelectedStore>
               <gfs1:DropPointID>10</gfs1:DropPointID>
              <gfs1:DropPointProviderID>1405</gfs1:DropPointProviderID>
            </gfs:SelectedStore>             <gfs:SelectedSuperservice>
               <gfs1:DeliveryOptionId>D1S2</gfs1:DeliveryOptionId>
            </gfs:SelectedSuperservice>
            <gfs:Session>
               <gfs1:APIKeyID>API_KEY_HERE</gfs1:APIKeyID>
               <gfs1:SessionID>7baa473f-1158-4262-9d71-9a487cf94643</gfs1:SessionID>
            </gfs:Session>
         </tem:closeCheckoutRequest>
      </tem:CloseCheckout>
  </soapenv:Body>
</soapenv:Envelope>

CheckoutServiceAvailability

CheckoutServiceAvailability method call runs the same code as GetCheckoutOrder. Its purpose is to provide a fast, minimal size response that you can integrate for robust operations (i.e. checking delivery service validity for a country the moment it is selected, or as an item is inserted into the shopping cart)

ProcessCheckoutOrder will have to be called in the end in order to get a detailed delivery service response.

CheckoutServiceAvailability validates only ‘dmStandard’ delivery type requests. dmStores or dmDropPoints are not supported

Sample Request (with header included):

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:gfs="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Request" xmlns:gfs1="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Partial" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:gfs2="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Enumerations">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:CheckoutServiceAvailability>
         <tem:processCheckoutOrderRequest>
            <gfs:DateRange>
               <gfs1:DateFrom>2015-12-19</gfs1:DateFrom>
               <gfs1:DateTo>2015-12-25</gfs1:DateTo>
            </gfs:DateRange>
            <gfs:Order>
               <gfs1:Transit>
                  <gfs1:Recipient>
                     <gfs1:Location>
                        <gfs1:CountryCode>
                           <gfs1:Code>GB</gfs1:Code>
                           <gfs1:Encoding>ccISO_3166_1_Alpha2</gfs1:Encoding>
                        </gfs1:CountryCode>
                        <gfs1:Postcode>EX123LT</gfs1:Postcode>
                     </gfs1:Location>
                  </gfs1:Recipient>
               </gfs1:Transit>
               <gfs1:Value>
                  <gfs1:CurrencyCode>GBP</gfs1:CurrencyCode>
                  <gfs1:Value>10</gfs1:Value>
               </gfs1:Value>
            </gfs:Order>
            <gfs:RequestedDeliveryTypes>
               <gfs2:DeliveryMethodEnumeration>dmStandard</gfs2:DeliveryMethodEnumeration>
            </gfs:RequestedDeliveryTypes>
            <gfs:Session>
               <gfs1:APIKeyID> YOUR_API_KEY_HERE </gfs1:APIKeyID>
            </gfs:Session>
         </tem:processCheckoutOrderRequest>
      </tem:CheckoutServiceAvailability>
   </soapenv:Body>
</soapenv:Envelope>


Sample  response:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <CheckoutServiceAvailabilityResponse xmlns="http://tempuri.org/">
         <CheckoutServiceAvailabilityResult xmlns:a="http://schemas.datacontract.org/2004/07/GFS.Enterprise.Checkout.Public.DataContracts.Response" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:Delivery>true</a:Delivery>
         </CheckoutServiceAvailabilityResult>
      </CheckoutServiceAvailabilityResponse>
   </s:Body>
</s:Envelope>