Insert/update catalog

To insert one or more catalogs, it's necessary to make a POST call, passing a JSON body as specified below.

Depending on the amount of requested data, the stock creation can last some seconds up to many minutes, so this is why the web service is asynchronous, and it's mandatory to specify a callback URL that will be called once the stock has been created.

The web service response will be composed of:

success: Boolean that indicated wether the request was successful or not

code : HTTP Code for the response

200 means the request was correctly processed

204 means a duplicate record was found in KeepIT, and that no insertion was performed

206 means that not all records were inserted or processed

400 means that the request body is invalid or contains syntax errors

500 means a server error has happened

message: response message for the request (e.g. "Insertion successful" or "Missing required parameter")

errorObjects: Array that contains the objects that caused errors when processed

insertedObjects: Array that contains the correctly processed objects

progId: The identifier for the inserted/updated object

catalogCode: The identifier for catalog code

This is the list of fields that can be passed in the request body:

Field	Description	Type	Mandatory
callbackUrl	URL to be called with a POST request once the stock creation is termined	String
catalogsRecords	Array of catalogs objects	An array of objects (see below for the complete structure).	✓

Item Catalogs section

Field	Description	Type	Mandatory
catalogCode	Catalog code	Varchar(250)	✓
description	Catalog description	Varchar(250)	✓
startDate	Date start validity catalog	Date	✓
endDate	Date end validity catalog.End date must be greater then start date	Date
channel	Channel of catalog	Varchar(250)	✓
active	Indicates wether the catalog is active or not ('T' for actived or 'F' for not actived)	Char(1)	✓
priceList	Price list code	Varchar(250)	✓
status	Indicates wether the tag is active or not ('E' for actived or 'D' for not actived)	Char(1)

Catalog Detail section

Field	Description	Type	Mandatory
itemCode	Item code	Varchar(250)	✓
active	Indicates wether the item is active or not for catalog ('T' for actived or 'F' for not actived)	Varchar(250)	✓
title	Title of item.You can also pass the description in language (e.g. titleIt)	Varchar(250)	✓
descriptionText	Extended description.You can also pass the description in language (e.g. descriptionTextIt)	Varchar(715827882)
productInformation	Product information.You can also pass the description in language (e.g. productInformationIt)	Varchar(715827882)
productCare	Product care.You can also pass the description in language (e.g. productCareIt)	Varchar(715827882)
status	Indicates wether the tag is active or not ('E' for actived or 'D' for not actived)	Char(1)
itemCatalogTags	Array of tags catalog objects (see below for the complete structure)	Array
itemCatalogHieLevels	Object of branch hierarchy levels catalog (see below for the complete structure)	Object

Item Catalog Tags section

Field	Description	Type	Mandatory
tag	Tag	Varchar(250)	✓
status	Indicates wether the tag is active or not ('E' for actived or 'D' for not actived)	Char(1)

Item Catalog Hie Levels section
Hierarchies must first be entered with services insertHierarchiesItemCatalog_v3****.

Field	Description	Type	Mandatory
status	Indicates wether the tag is active or not ('E' for actived or 'D' for not actived)	Char(1)
array	Array of hierarchy levels objects (see below for the complete structure)	Array	✓

Field	Description	Type	Mandatory
levelNumber	Level tree	Numeric(5)	✓
hierarchyCode	Hie Levels code	Varchar(250)	✓

catalogsRecords example

"catalogsRecords": [{
    "itemCatalogs": {
        "catalogCode": "catalog code",
        "description": "catalog description",
        "startDate": "start date validity catalog",
        "endDate": "end date validity catalog",
        "channel": "channel catalog",
        "active": "Indicates wether the catalog is active or not ('T' for actived or 'F' for not actived)",
        "priceList": "price list code",
        "status": "status"
    },
    "catalogDetail": [{
        "itemCode": "item code",
        "active": "Indicates wether the item is active or not for catalog ('T' for actived or 'F' for not actived)",
        "title": "title product",
        "titleEn": "title product in english",
        "descriptionText": "extended description",
        "productInformation": "product information",
        "productCare": "product care",
        "status": "status",
        "itemCatalogTags": [{
                "tag": "tag",
                "status": "status"
            }],
        "itemCatalogHieLevels": {
            "branch1":{
                "status":"E",
                "array": [
                {
                    "levelNumber": "level tree",
                    "hierarchyCode": "hie Levels code"
                },
                {
                    "levelNumber": "level tree",
                    "hierarchyCode": "hie Levels code"
                }]
            }
        }
    }]
}]

Response example

{
    "success": true,
    "code": 200,
    "message": "Insert/update successful",
    "errorObjects": [],
    "insertedObjects": [
        {
            "progId": "2604",
            "catalogCode": "TEST"
        }
    ]
}

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
  "callbackUrl": "https://yourcallbackurl",
  "catalogsRecords": [
    {
      "itemCatalogs": {
        "catalogCode": "TEST",
        "description": "Catalogo di test",
        "startDate": "2018-06-28",
        "endDate": "2019-06-28",
        "channel": "ONLINE",
        "active": "T",
        "priceList": "import1"
      },
      "catalogDetail":[{
          "itemCode": "000",
          "active": "T",
          "title": "SCARPA UOMO",
          "titleEn": "SCARPA UOMO EN",
          "descriptionText": "",
          "productInformation": "",
          "productCare": "",
          "itemCatalogTags": [
            {
              "tag": "NUOVO"
            }
            ],
          "itemCatalogHieLevels": {
                "branch1":{
                    "status": "E",
                    "array":[{
                        "levelNumber": "1",
                        "hierarchyCode": "ABBIGLIAMENTO"
                    },
                    {
                        "levelNumber": "2",
                        "hierarchyCode": "CAMICIE"
                    }]
                }
            }
        }
      ]
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert/update catalog

Request

Request Code Samples

Responses