Skip to main content

​
Products catalog Import

In order to synchronize the Product Catalog, it is necessary to call 2 endpoints in sequence:
  1. Call productCategories endpoint (the response will contain errors or warnings that occurred during the import process)
  2. Call products endpoint (the response will contain errors or warnings that occurred during the import process)

​
Product Categories

POST /pos//company//import/productCategories

​
Input request

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

​
Input parameters

Field nameDescription
nameCategory name
posProductParentCategoryIdParent Category Id in POS (if exists)
posProductCategoryIdCategory ID in POS
posCatalogIdProduct Catalog Id (if exists)

​
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 /pos//company//import/products

​
Input request

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

​
Input parameters

Field nameDescription
productIdPOS Product Id
ProductNameProduct Name in POS
manufacturerProduct Manufacturer (if exists)
priceProduct price
externalCategoryIdsCategory 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"
      }
    ]
  }
}