• Home
  • Documentation
  • Blog
  • Case Studies
  • Forum
  • Home
  • Documentation
  • Delivery Option Package
  • Enumerations Package
  • Partial Package
  • Request Package
  • Response Package
  • Mandatory Fields



Documentation
  • GFS Checkout
    • Overview
    • Management Console
      • Introduction
      • Home Page
      • Service Configuration
      • Service Rules
      • Store Estates
      • Drop Point Providers
      • Account (Global) Settings
    • The GFS Checkout Widgets
      • Introduction
      • Installation
      • Security
      • Using the Widgets
      • Checkout Widget
      • Store Widget
      • Carrier Icon Widget
      • Supported Carriers Widget
      • Carrier Information Widget
      • Droppoint Widget
      • Selected Droppoint Widget
      • Delivery Address Widget
      • Example eCommerce Site
    • The Checkout API
      • Overview
      • Response Codes
      • API calls
      • Data Structure
        • Delivery Option Package
        • Enumerations Package
        • Partial Package
        • Request Package
        • Response Package
        • Mandatory Fields
      • Examples
      • API Best Practices
  • GFS Channel Connector
    • Overview
    • Software Installation
    • Integrated Channels
      • Amazon
      • Channel Advisor
      • eBay
      • Etsy
      • Magento
        • Overview
        • Magento 1.9.x Configuration
        • Magento 2.1.X Configuration
      • Not On The Highstreet
      • Shopify
      • WooCommerce
  • GFS Selector
    • Overview
  • Tracking Integration
    • Overview
  • Collections and Returns Integration
    • Overview

Mandatory Fields

GetCheckoutOrder (ProcessCheckoutOrder)

For all calls to GetCheckoutOrderRequest, the following fields must be supplied:

  • DateRange
  • ApiKeyID
  • Order Value
  • Order Currency Code
  • Recipient Email
  • Recipient Country Code
  • Recipient Country Code Encoding
  • Recipient Postcode
  • Recipient Town
  • Recipient First name
  • Recipient Last name
  • Recipient Title

The contents collection is also mandatory, each item in the collection must contain the following mandatory fields

  • Order Item Value
  • Order Item Currency Code
  • Order Item Description or ShortDescription
  • Order Item Product code
  • Order Item quantity

CloseCheckout

 For all calls to CloseCheckoutRequest, the following fields must be supplied:

  • APIKeyID
  • SessionID
  • SelectedSuperService DeliveryOptionID.

If the DeliveryOptionID points to a non dmStandard superservice type, then the relevant selection of store or droppoint will also have to be supplied.


  • T 08456 044 011
  • E devsupport@justshoutgfs.com
©2017 Global Freight Solutions Ltd
Century House, 100 Station Road, Horsham, West Sussex, United Kingdom, RH13 5UZ.
GFS Website
Terms and Conditions
Privacy Policy