Import Categories [POST]

Overview

Allows you to upload all categories for use with retailing for RCM (max 500MB)

Parameters

Parameter	Type	Description
title	`string`	Page title this normally matches with your product category pages.
clientCategoryId	`string`	This is your unique internal identifier for the page.
url	`string`	This is the URL for the page i.e. /dresses.aspx
parentClientCategoryId	`string`	The parent identifier for the page, allows for children pages.
site	`string`	This is the site name used to describe your regional version of the website.

Example Value

200 response
[
  {
    "title": "string",
    "clientCategoryId": "string",
    "url": "string",
    "parentClientCategoryId": "string",
    "site": "string"
  }
]

Response

Description: Import Accepted

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

Import Product List [GET]

Overview

Allows you to view the import results for the product upload.

Parameters

Parameter	Type	Description
Token	`string (query)`	Token assigned to your account.
ImportTaskId	`integer($int32) (query)`	Import Task ID supplied from the import request.

Response

200 response
{
  "importTaskId": 0,
  "createdDate": "2019-06-05T09:19:31.853Z",
  "completedDate": "2019-06-05T09:19:31.853Z",
  "recordsUpdated": 0,
  "itemResults": [
    {
      "clientProductId": "string",
      "errors": [
        "string"
      ],
      "valid": true
    }
  ],
  "responseTime": "string",
  "token": "string",
  "errors": [
    "string"
  ]
}

Import Page Result [GET]

Overview

Allows you to view the import results for the page upload.

Parameters

Parameter	Type	Description
Token	`string (query)`	Token assigned to your account.
ImportTaskId	`integer($int32) (query)`	Import Task ID supplied from the import request.

Response

200 response
 {
  "importTaskId": 0,
  "createdDate": "2019-06-05T10:07:55.218Z",
  "completedDate": "2019-06-05T10:07:55.218Z",
  "recordsUpdated": 0,
  "itemResults": [
    {
      "clientPageId": "string",
      "errors": [
        "string"
      ],
      "valid": true
    }
  ],
  "responseTime": "string",
  "token": "string",
  "errors": [
    "string"
  ]
}

Import Category Result [GET]

Overview

Allows you to view the import results for the categories upload.

Parameters

Parameter	Type	Description
Token	`string (query)`	Token assigned to your account.
ImportTaskId	`integer($int32) (query)`	Import Task ID supplied from the import request.

Response

200 response
{
  "importTaskId": 0,
  "createdDate": "2019-06-05T10:08:36.560Z",
  "completedDate": "2019-06-05T10:08:36.560Z",
  "recordsUpdated": 0,
  "itemResults": [
    {
      "clientCategoryId": "string",
      "errors": [
        "string"
      ],
      "valid": true
    }
  ],
  "responseTime": "string",
  "token": "string",
  "errors": [
    "string"
  ]
}

Import Stock Result [GET]

Overview

Allows you to view the import results for the stock upload.

Parameters

Parameter	Type	Description
Token	`string (query)`	Token assigned to your account.
ImportTaskId	`integer($int32) (query)`	Import Task ID supplied from the import request.

Response

200 response
{
  "importTaskId": 0,
  "createdDate": "2019-06-05T10:47:24.839Z",
  "completedDate": "2019-06-05T10:47:24.839Z",
  "recordsUpdated": 0,
  "responseTime": "string",
  "token": "string",
  "errors": [
    "string"
  ],
  "itemResults": [
    {
      "clientProductId": "string",
      "stockCode": "string",
      "errors": [
        "string"
      ],
      "valid": true
    }
  ]
}

Import Pages [POST]

Overview

Allows you to upload all pages for use with retailing for RCM (max 500MB)

Parameters

Parameter	Type	Description
title	`string`	Page title this normally matches with your product category pages.
lientPageId	`string`	This is your unique internal identifier for the page.
url	`string`	This is the URL for the page i.e. /dresses.aspx
parentClientPageId	`string`	The parent identifier for the page, allows for children pages.
site	`string`	This is the site name used to describe your regional version of the website, as supplied in the feeds to RCM.

Example Value

200 response
[
  {
    "title": "string",
    "clientPageId": "string",
    "url": "string",
    "parentClientPageId": "string",
    "site": "string"
  }
]

Response

Description:
Import Accepted

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

Import Products [POST]

Overview

Allows you to upload a JSON file for all your product data per site (max 500MB)

Parameters

Parameter	Type	Description
siteName	`string`	This is the site name used to describe your regional version of the website.
productCode	`string`	Product Code used to identify your product, this doesn’t need to be unique.
clientProductId	`string`	Unique ID for the product, this is normally the primary key used from your own systems. This will be returned back to you in merch API calls.
groupProductCode	`string`	Group product code is a ID field used to group items together which fit in the same style, for example could be used to group together all the same dresses.
title	`string`	This is the customer facing Title for the product.
description	`string`	This is the customer facing Description for the product.
metaTitle	`string`	This is the HTML Meta Title for the page.
metaDescription	`string`	This is the HTML Meta Description for the page.
url	`string`	This is the URL for the product page.
pages	`string`	These are the active pages this product is assigned to, please ensure you have supplied the pages first using the import pages API.
categories	`string`	These are the categories this product is assigned to, please ensure you have supplied the categories first using the import categories API.
productAttributes	`info`	These are the attributes this product is assigned to. Only Brand is currently supported.
productAttributes	`string`	attributeName
productAttributes	`string`	attributeValue
facets	`info`	These are the product facets such as Red, Blue, Silk etc. assigned to a product for filtering.
facets	`string`	facetName
facets	`string`	facetValue
images	`info`	These are the product images.
images	`string`	imageUrl
images	`string`	colour
prices	`info`	These are the product prices, you can supply multiple prices per product for different currencies.
prices	`string`	currency
prices	`number($double)`	itemPrice
prices	`number($double)`	rrp
prices	`number($double)`	salePrice
prices	`number($double)`	costPrice
dateAvailableFrom	`string($date-time)`	Show product after this date.
dateAvailableTo	`string($date-time)`	Do not show product after this date.

Example Value

200 response
[
  {
    "siteName": "string",
    "productCode": "string",
    "clientProductId": "string",
    "groupProductCode": "string",
    "title": "string",
    "description": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "url": "string",
    "pages": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "productAttributes": [
      {
        "attributeName": "string",
        "attributeValue": "string"
      }
    ],
    "facets": [
      {
        "facetName": "string",
        "facetValue": "string"
      }
    ],
    "images": [
      {
        "imageUrl": "string",
        "colour": "string"
      }
    ],
    "prices": [
      {
        "currency": "string",
        "itemPrice": 0,
        "rrp": 0,
        "salePrice": 0,
        "costPrice": 0
      }
    ],
    "dateAvailableFrom": "2019-06-05T11:27:03.542Z",
    "dateAvailableTo": "2019-06-05T11:27:03.542Z"
  }
]

Response

Description:
Import Accepted

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

Import Stock [POST]

Overview

Allows you to upload a JSON file for all your product stock data (max 500MB)

Parameters

Parameter	Type	Description
clientProductID	`string`	Unique ID for the product, this is normally the primary key used from your own systems.
stockCode	`string`	Stock code for the item. This should be unique such as UPC code.
stockTitle	`string`	Title for the stock item such as Large, Small.
quantity	`integer($int32)`	Current Qty available for stock item.
archived	`boolean`	Set to true once stock item is not available for sale.

Example Value

200 response
[
  {
    "clientProductID": "string",
    "stockCode": "string",
    "stockTitle": "string",
    "quantity": 0,
    "archived": true
  }
]

Response

Description:
Import Accepted

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

Import Categories [POST]

Overview​

Parameters​

Example Value​

Response​

Import Product List [GET]​

Overview​

Parameters​

Response​

Import Page Result [GET]​

Overview​

Parameters​

Response​

Import Category Result [GET]​

Overview​

Parameters​

Response​

Import Stock Result [GET]​

Overview​

Parameters​

Response​

Import Pages [POST]​

Overview​

Parameters​

Example Value​

Response​

Import Products [POST]​

Overview​

Parameters​

Example Value​

Response​

Import Stock [POST]​

Overview​

Parameters​

Example Value​

Response​

Overview

Parameters

Example Value

Response

Import Product List [GET]

Overview

Parameters

Response

Import Page Result [GET]

Overview

Parameters

Response

Import Category Result [GET]

Overview

Parameters

Response

Import Stock Result [GET]

Overview

Parameters

Response

Import Pages [POST]

Overview

Parameters

Example Value

Response

Import Products [POST]

Overview

Parameters

Example Value

Response

Import Stock [POST]

Overview

Parameters

Example Value

Response