DEVELOPERS API OVERVIEW

Our RestFul JSON API makes it easy for website developers to add our Product Personalisation Apps to any eCommerce website. The diagram above gives an overview of how this works and if you click the green button below you will get full access to more detailed technical documentation

  •  APIs are designed for web developers – if you do not have experience in working with APIs you should either hire a web developer or look at our Extensions & Plugins page
  • Our API has been implemented on over 2000 websites so is  tried and tested
  • Typically it should take no more than a few days to add our API to any eCommerce website
  • You will need an API key to complete any integration work but the details supplied should enable you to estimate the development work involved

Available APIs List

  • Smartlink API – for adding previews / configurators to your website & products tp your shopping cart
  • Order-iT API – tell Gateway OMS when payment made and provide delivery address details / get status updates
  • Virtual Product Creator API – add our VPC to your website and get details of the products created to auto publish
  • Order API / XML – for suppliers to collect orders & update order status also for accounts integrations
  • Order Shipping API – allows suppliers to make use of the platform’s various shipping integrations & create labels
  • Stock API – allows suppliers to update stock levels in OMS & retailers to retrieve them
  • Product API – allows retailers to auto download product data for websites from Gateway CPP
  • Trade Portal API – create / authorise accounts in OMS and view orders and their status
  • Save API – capture project details when Smartlink “Save” button clicked to store samples and enable reload / edit
  • External Galleries API – use the Smartlink external gallery to utilise images that are hosted on 3rd party websites.

Full API Technical Documentation

Main API Functions

Add our product personalisation apps to your website, kiosk or portal

Add Smartlinks

Add our orders to our Order Management System from other sources

Add Orders to OMS

Collect customised orders from our Order Management System to add to supplier workflow systems

Collect Orders from OMS

Get an update everytime an order status is updated via your own callback endpoint

Get Order Status Updates

Add our Virtual Product Creator to your website

Add VPC to your Website

Other Integration Options