Insert Mappings - 4WS Suite

To insert one or more mappings, it's necessary to make a POST call, passing a JSON body as specified below.
If an existing externalValue is specified, the value saved in KeepIT will be overwritten.

The web service response will be composed of:

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

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

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

Field	Description	Type	Mandatory
codeMappingRulesRecords	Array of mappings objecs	See below for the the object structure	✓

Field	Description	Type	Mandatory
system	System to be used to save mapping	Varchar(250)	✓
mappingCategory	Category of the mapping. Allowed values are: ITEM BARCODE	Varchar(250)	✓
externalValue	Mapping code on the external system (e.g. Shopify Item ID)	Varchar(250)	✓
value	Mapping code saved on KeepIT (e.g. ItemCode of an item)	Varchar(250)	✓

Responses example

{
    "success": true,
    "message": "Insert successful"
}
{
    "success": false,
    "message": "system, mappingCategory parameters missing"
}

Notes

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

Request

Query Params

Header Params

Body Params application/json

Example

{
    "codeMappingRulesRecords": [
        {
            "system": "SHOPIFY" ,
            "mappingCategory": "ITEM",
            "externalValue": "IT_1",
            "value": "ITEM-1"
        },
        {
            "system": "SHOPIFY" ,
            "mappingCategory": "ITEM",
            "externalValue": "IT_2",
            "value": "ITEM-2"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart