Get Page [GET]

Overview

Supply a valid token and site name with a merch page id to retrieve the full merch page JSON data.

Parameters

Parameter	Type	Description
Token	string (query)	Token supplied during on-boarding or can be generated from within RCMAdmin.
SiteName	string (query)	This is the site name used to describe your regional version of the website, as supplied in the feeds to RCM.
MerchPageId	integer($int32) (query)	Merch Page ID, you can get this from within RCMAdmin for the site.
Currency	string (query)	3 Digit ISO Currency code. for example. GDP, FRA, USD etc.
Take	integer($int32) (query)	How many products to get, i.e. 10 products.
Skip	integer($int32) (query)	How many products to skip, for example if we are showing 10 products per page and are page two we would supply skip the first 10.
SortBy	string (query)	Which Sort to apply to the dataset.
FilterByIds	array[integer] (query)	Which Facets are currently selected.

Example Value

200 response

{
  "title": "string",
  "url": "string",
  "metaTitle": "string",
  "metaDescription": "string",
  "pageContent": "string",
  "onPageTitle": "string",
  "onPageDescription": "string",
  "ruleId": 0,
  "totalProducts": 0,
  "adverts": [
    {
      "title": "string",
      "image": "string",
      "position": 0,
      "url": "string"
    }
  ],
  "facets": [
    {
      "facetId": 0,
      "position": 0,
      "collapsed": true,
      "defaultCount": 0,
      "numberOfColumns": 0,
      "facetName": "string",
      "facetValues": [
        {
          "facetId": 0,
          "facetValueId": 0,
          "facetName": "string",
          "facetValue": "string",
          "position": 0,
          "count": 0
        }
      ]
    }
  ],
  "products": [
    {
      "productCode": "string",
      "title": "string",
      "description": "string",
      "productUrl": "string",
      "imageUrl": "string",
      "RCMProductId": 0,
      "thirdPartyProductId": "string",
      "rank": 0,
      "price": 0,
      "rrp": 0,
      "isAdvert": true
    }
  ]
}

Response

Description:
merch page returned

200 response

{
  "success": true,
  "errors": [
    "string"
  ],
  "importTaskId": 0
}

---

Get Product [GET]

Overview

Supply the token, site name and third party product id to retrieve the full product in JSON format.

Parameters

Parameter	Type	Description
Token	string (query)	Token supplied during on-boarding or can be generated from within RCMAdmin.
SiteName	string (query)	This is the site name used to describe your regional version of the website, as supplied in the feeds to RCM.
ThirdPartyProductId	string (query)	The product id as defined from your system.

Example Value

200 response

{
  "productId": 0,
  "thirdPartyProductId": "string",
  "productCode": "string",
  "title": "string",
  "description": "string",
  "url": "string",
  "newIn": true,
  "totalStock": 0,
  "facets": [
    {
      "facetValueId": 0,
      "facetName": "string",
      "facetValue": "string"
    }
  ],
  "images": [
    {
      "imageUrl": "string",
      "searchKeywords": "string"
    }
  ],
  "prices": [
    {
      "price": 0,
      "rrp": 0,
      "salePrice": 0,
      "currencyIsoCode": "string"
    }
  ]
}

Response

Description:
product data returned

200 response

{
  "success": true,
  "errors": [
    "string"
  ],
  "importTaskId": 0
}

---

Get Product [GET]

Overview

Supply the token, site name to get trending data.

Parameters

Parameter	Type	Description
Token	string (query)	Token supplied during on-boarding or can be generated from within RCMAdmin.
SiteName	string (query)	This is the site name used to describe your regional version of the website, as supplied in the feeds to RCM.
Currency	string (query)	The product currency using the 3 digit ISO code.

Example Value

200 response

{
  "responseTime": "string",
  "token": "string",
  "errors": [
    "string"
  ],
  "trendingProducts": [
    {
      "thirdPartyProductId": "string",
      "title": "string",
      "description": "string",
      "productCode": "string",
      "imageUrl": "string",
      "currency": "string",
      "price": 0,
      "rrp": 0,
      "salePrice": 0
    }
  ],
  "popularSearches": [
    "string"
  ],
  "trackingData": {
    "pageId": 0,
    "ruleId": 0
  }
}

Response

Description:
product data returned

200 response

{
  "success": true,
  "errors": [
    "string"
  ],
  "importTaskId": 0
}

---