Insert/Update dimensions

To insert one or more dimensions, it's necessary to make a POST call, passing a JSON body as specified below.
The web service can also assign a dimension to a dimensionGrouping, so that you can then set a price for the whole grouping instead of setting it for every dimension.

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 object

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

Field	Description	Type	Mandatory
dimensionsRecords	Array of dimension objecs	`[{ dimensionType: string, dimensionGroup: string, dimensionLevel: string, description: string, position: int number }]` To update a dimension also specify the progId, which is the identifier for the dimension	✓

Response example

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

Notes

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

Request

Query Params

Header Params

Body Params text/plain

Example

Example:{ "dimensionsRecords": [ { "dimensionType": "TAGLIA", "dimensionGroup": "58913", "dimensionLevel": "1", "description": "Small", "position": 1 }, { "dimensionType": "TAGLIA", "dimensionGroup": "58913", "dimensionLevel": "2", "description": "Medium", "position": 2 } ] }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

text/html

Body

Example

{"success":true,"code":200,"message":"Inserimento/Update riuscito con successo.","errorObjects":[],"insertedObjects":[{"progId":"8795"}]}

Insert/Update dimensions

Request

Request Code Samples

Responses