Get Mappings - 4WS Suite

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

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 - Additional data regarding hierarchies and attributes will be returned as well BARCODE - Additional data regarding dimensions and dimension groups will be returned as well	Varchar(250)	✓
externalValue	Mapping code on the external system (e.g. Shopify Item ID)	Varchar(250)	✓
externalValue	Mapping code to be decoded (e.g. Shopify Item ID)	Varchar(250)	✓

A decoded field will be added for each record, containing the decoded value for the provided externalValue.

Responses example

{
    "success": true,
    "codeMappingRulesRecords": [
        {
            "system": "SHOPIFY",
            "externalValue": "IT-1",
            "decoded": "ITEM-1"
        }
    ]
}
{
    "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"
        },
        {
            "system": "SHOPIFY" ,
            "mappingCategory": "BARCODE",
            "externalValue": "654321"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart