Products catalog Import

In order to synchronize the Product Catalog, it is necessary to call 2 endpoints in sequence:

Call productCategories endpoint (the response will contain errors or warnings that occurred during the import process)
Call products endpoint (the response will contain errors or warnings that occurred during the import process)

Product Categories

POST https://apitest.clearline.me/pos/{posSystemId}/company/{posCompanyId}/import/productCategories

Input request

{
  "items": [
    {
      "name": "string",
      "posProductParentCategoryId": "string",
      "posProductCategoryId": "string",
      "posCatalogId": "string",
      "imageUrl": "string"
    }
  ]
}

Input parameters

Field name	Description
name	Category name
posProductParentCategoryId	Parent Category Id in POS (if exists)
posProductCategoryId	Category ID in POS
posCatalogId	Product Catalog Id (if exists)
imageUrl	Product image url

Response

{
  "data": {
    "status": "string",
    "createdCount": 0,
    "updatedCount": 0,
    "errors": [
      {
        "entityId": "string",
        "rowNumber": 0,
        "errorMessage": "string",
        "errorDetails": "string"
      }
    ],
    "warnings": [
      {
        "entityId": "string",
        "rowNumber": 0,
        "message": "string",
        "details": "string"
      }
    ]
  }
}

Products

POST https://apitest.clearline.me/pos/{posSystemId}/company/{posCompanyId}/import/products

Input request

 {
  "items": [
    {
      "product": {
        "productId": "string",
        "productName": "string",
        "manufacturer": "string",
        "price": 0
      },
      "externalCategoryIds": [
        "string"
      ]
    }
  ]

}

Input parameters

Field name	Description
productId	POS Product Id
ProductName	Product Name in POS
manufacturer	Product Manufacturer (if exists)
price	Product price
externalCategoryIds	Category ID in POS (which were created in the productCategories endpoint call)

Response

  {
  "data": {
    "status": "string",
    "createdCount": 0,
    "updatedCount": 0,
    "errors": [
      {
        "entityId": "string",
        "rowNumber": 0,
        "errorMessage": "string",
        "errorDetails": "string"
      }
    ],
    "warnings": [
      {
        "entityId": "string",
        "rowNumber": 0,
        "message": "string",
        "details": "string"
      }
    ]
  }
}

Getting Started

Integration Options

POS Integration

API Reference

Products Catalog Import to CMC

Products catalog Import

Product Categories

Input request

Input parameters

Response

Products

Input request

Input parameters

Response

​Products catalog Import

​Product Categories

​Input request

​Input parameters

​Response

​Products

​Input request

​Input parameters

​Response

Products catalog Import

Product Categories

Input request

Input parameters

Response

Products

Input request

Input parameters

Response