CMS API Documentation

 

 

Overview

The purpose of this website is to provide a developer's reference to the Marketpath API.

 

REST API

The Marketpath API uses a REST-based interface. Marketpath API calls are made over the Internet by sending HTTP GET or POST requests to our server. For example, to get the root level categories for a store, the following URL should be constructed:

https://api.marketpath.com/v1.0/storefront/A85CC08C-A53E-46D7-8018-F815C4608A98/getcategories


You will need a username and API key to use the Marketpath API. API Keys can be obtained by sending a request to support@marketpath.com.

 

Headers

Authorization

Any call that results in adding or modifying data is required to pass in an authorization token. This is accomplished by adding an HTTP header field named "Authorization".

Authorization=[Username]:[APIKey]

 

Note: Authorization data may also be submitted as part of the query string using the parameters Username and APIKey.

 

?Username=[Username]&APIKey=[APIKey]

 

HTTP_ACCEPT

The HTTP_ACCEPT header should be set to either application/xml or application/json. Failing to set the HTTP_ACCEPT header or setting as any other type will result in a response of "UNKNOWN".

 

Note: As of this version, only application/xml is accepted.

 

Marketpath API Base URI Structure

The Marketpath API uses the following base URI structure for all API calls

https://api.marketpath.com/[Version]/[SiteGUID]/[System]/[Operation]/...

 

Parameter

Description

Required

Version

Currently only "v1.0"

Yes

System

Specifies which application or system to use

            Values

            storefront
            cms

Yes

SiteGUID

Unique identifier of System. This could be a store GUID or a CMS site GUID.

Yes

Operation

Action to be taken

YES

 

This following URI will be subsequently referred to as "" in order to save space in this reference document:

 

https://api.marketpath.com/[Version]/[SiteGUID]/[System]

 

Additionally, some operations call for more values. In this case, you will use a standard query string after the Operation parameter

 

/[Operation]?param1=1234