Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Create pricelist(s)

RequestPOST /editor/plugins_matchanalysis_pricingpreset
Params

presetId Required. ID of preset for which you want to create new pricelist(s)


sourceLanguageIds RequiredComma-separated list of IDs of source and target languages to create the pricelist for each possible combinations of, except the ones for which the pricelist do already exist.

targetLanguageIds Required. 


Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true,
    "append": [
        {
            "id": "3",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "339",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "4",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "340",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "5",
            "presetId": "2",
            "sourceLanguageId": "330",
            "targetLanguageId": "339",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "6",
            "presetId": "2",
            "sourceLanguageId": "330",
            "targetLanguageId": "340",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        }
    ]
}



Clone

preset

pricelist

RequestPOST /editor/plugins_matchanalysis_pricingpreset
/clone
Params
presetId

priceId Required. ID of preset

to be clonedname Required. Name for the clone, it should be unique across the all presets

customerId Optional. ID of customer. This param should be provided if you want new preset to be customer-specific one

pricelist which you want to clone


sourceLanguageIds RequiredComma-separated list of IDs of source and target languages to clone the certain pricelist for each possible combinations of, except the ones for which the pricelist do already exist.

targetLanguageIds Required. 


Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true,
    "
clone
append": [
       
{
 {
            "id": "3",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "339",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "4",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "340",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "5",
            "presetId": "2",
            "sourceLanguageId": "330",
            "targetLanguageId": "339",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "6",
            "presetId": "2",
            "sourceLanguageId": "330",
            "targetLanguageId": "340",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "
id
range14": 
"5"
0,
            "
customerId
range15": 
null
0,
            "
name
range16": 
"asd1"
0,
            "
unitType
range17": 
"word"
0,
            "
description
range18": 
null
0,
            "
priceAdjustment
range19": 
"
0
.00",

        
"isDefault": "0"
}
    
}
]
}



Edit preset

RequestPUT /editor/plugins_matchanalysis_pricingpreset
Params

presetId Required. ID of preset to be edited


name Optional. Name for the clone, it should be unique across the all presets, should be either not empty or not mentioned among the params

unitType=(word|character) Optional. Type of units that the preset should be based on, i.e. word-based or character-based


description Optional. Short description for the preset up to 255 characters long


priceAdjustment Optional. Value to be appended to final price. Should be a decimal value with up to 2 digits after floating point.


isDefault=(0|1) Optional. Set this preset to be the default one for it's customer, if it's a customer-specific preset, or the generally default


Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true,
    "updated": {
        "id": "5",
        "customerId": null,
        "name": "Some preset",
        "unitType": "word",
        "description": "asd",
        "priceAdjustment": "0.00",
        "isDefault": "0"
    }
}


...