(Quick Reference) Service: Upsert

Description: This web service is used to insert a price list object to the database if it does not already exist, or update it.

URL with external_id:


Method: POST

Request content type: application/json


NameDescriptionTypeRequiredExample values
namethe name of the new item groupStringYes 
cumulateWithPromotionSet to true by defaultBooleanNotrue, false
cumulateWithDiscountSet to true by defaultBooleanNotrue, false
isDefaultInOtherMobileOperationSet to false by defaultBooleanNotrue, false
reference must be unique

Success Output

Success case: response.status=201
    "id": 8,
    "name": "AddedPriceLIst",
    "reference": "PL-007",
    "cumulateWithPromotion": false,
    "cumulateWithDiscount": true,
    "isDefaultInOtherMobileOperation": false,
    "organization": "Lyon",
    "dateCreated": "2016-08-18T15:19:10Z",
    "lastUpdated": "2016-08-18T15:19:10Z"

Failure Output

Failure case:response.status = 400
    "error": "missing_param",
    "error_description": "reference parameter is missing"
    "error": "not_unique",
    "error_description": "reference already used"
    "error": "invalid_param_type",
    "error_description": "An invalid value was specified for parameter: cumulateWithDiscount (must be Boolean)"
     "error": "save_failed",
     "error_description": "Failed to save instance"

Failure case:response.status = 500
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."