(Quick Reference)

38 Assign categories of customers to price Lists - Reference Documentation

Version: 2.1

38 Assign categories of customers to price Lists

38.1 List

Service: List

Description: This web service return the list of customerCategoryPriceLists data in JSON Format

URL:

https://BASE_URL/api/VERSION/customerCategoryPriceLists

Method: GET

Parameters:

Pagination parameters:

NameDescriptionTypeRequiredPossible values
offsetTells where to start returning records from the entire set of resultsIntegerNo 
maxlimits the number of resources requested to returnIntegerNo 
sortOrders the results by the specified fieldStringNo 
orderOrders ascending (ASC) or descending DESCIntegerNoasc, desc

Filters parameters:

NameDescriptionTypeRequiredExample values
dateCreated_gtFilters by the resource's creation date time and operator greater thanDateno2016-08-15T14:52:48Z
dateCreated_gteFilters by the resource's creation date time and operator greater than or equalDateno 
dateCreated_ltFilters by the resource's creation date time and operator less thanDateno 
dateCreated_lteFilters by the resource's creation date time and operator less than or equalDateno 
lastUpdated_gtFilters by the resource's last-modified date time and operator greater thanDateno 
lastUpdated_gteFilters by the resource's last-modified date time and operator greater than or equalDateno 
lastUpdated_ltFilters by the resource's last-modified date time and operator less thanDateno 
lastUpdated_lteFilters by the resource's last-modified date time and operator less than or equalDateno 
customerCategoryReferenceWildcard search by the resource's referenceStringnocustomerCategoryReference=Ref-6* , customerCategoryReference=*ef-6 , customerCategoryReference=*ef-6*
priceListReferenceWildcard search by the resource's referenceStringnopriceListReference=Ref-6* , priceListReference=*ef-6 , priceListReference=*ef-6*
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)

Success Output

Success case: response.status=200

{
    "paging": {
        "total": 3,
        "max": 100,
        "offset": 0,
        "previous": null,
        "next": null
    },
    "data": [
        {
            "id": 9,
            "priceListReference": "Ref-1",
            "customerCategoryReference": "101",
            "customerCategory": {
                "id": 3,
                "reference": "101",
                "name": "new Categ",
                "href": "/api/v1/customerCategories/3"
            },
            "priceList": {
                "id": 1,
                "reference": "Ref-1",
                "name": "Retail price",
                "href": "/api/v1/priceLists/1"
            },
            "organization": "Lyon",
            "dateCreated": "2016-08-24T10:43:40Z",
            "lastUpdated": "2016-08-24T10:43:40Z"
        },
        {
            "id": 10,
            "priceListReference": "Ref-1",
            "customerCategoryReference": "1111",
            "customerCategory": {
                "id": 61,
                "reference": "1111",
                "name": "joe",
                "href": "/api/v1/customerCategories/61"
            },
            "priceList": {
                "id": 1,
                "reference": "Ref-1",
                "name": "Retail price",
                "href": "/api/v1/priceLists/1"
            },
            "organization": "Lyon",
            "dateCreated": "2016-08-24T10:43:43Z",
            "lastUpdated": "2016-08-24T10:43:43Z"
        },
        {
            "id": 11,
            "priceListReference": "PL-007",
            "customerCategoryReference": "102",
            "customerCategory": {
                "id": 60,
                "reference": "102",
                "name": "Preferred Customers",
                "href": "/api/v1/customerCategories/60"
            },
            "priceList": {
                "id": 8,
                "reference": "PL-007",
                "name": "AddedPriceLIst",
                "href": "/api/v1/priceLists/8"
            },
            "organization": "Lyon",
            "dateCreated": "2016-08-24T10:43:47Z",
            "lastUpdated": "2016-08-24T10:43:47Z"
        }
    ]
}

Failure Output

Failure case:response.status = 400
{
   "error": "invalid_param",
   "error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}
{
    "error": "invalid_datetime_format",
    "error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
}

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

38.2 Show

Service: Show

Description: This web service return an existing customerCategoryPriceLists record of the specified id in JSON format

Method: GET

URL:

https://BASE_URL/api/VERSION/customerCategoryPriceLists/{id}

Parameters:

NameDescriptionTypeRequiredExample values
idid of the desired recordLongYes777

URL with external_id:

https://BASE_URL/api/VERSION/customerCategoryPriceLists/reference/{customerCategoryId}/{priceListId}

Parameters:

NameDescriptionTypeRequiredExamples values
customerCategoryIdreference of the customer categoryStringYesCC-002
priceListIdreference of the price listStringYesDL-001

Success Output

Success case: response.status=200
{
    "id": 9,
    "priceListReference": "Ref-1",
    "customerCategoryReference": "101",
    "customerCategory": {
        "id": 3,
        "reference": "101",
        "name": "new Categ",
        "href": "/api/v1/customerCategories/3"
    },
    "priceList": {
        "id": 1,
        "reference": "Ref-1",
        "name": "Retail price",
        "href": "/api/v1/priceLists/1"
    },
    "organization": "Lyon",
    "dateCreated": "2016-08-24T10:43:40Z",
    "lastUpdated": "2016-08-24T10:43:40Z"
}

Failure Output

Failure case:response.status = 400
{
    "error": "invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}

Failure case:response.status = 404
{
    "error": "not_found",
    "error_description": "The customer category price list with the id 999 doesn't exist."
}

38.3 Delete

Service: Delete

Description: This web service is used in order to delete an existing customerCategoryPriceLists object from the database

Method: DELETE

URL:

https://BASE_URL/api/VERSION/customerCategoryPriceLists/{id}

Parameters:

NameDescriptionTypeRequiredExamples values
idId of the customerCategoryPriceLists record to deleteLongYes777

URL with external_id:

https://BASE_URL/api/VERSION/customerCategoryPriceLists/reference/{customerCategoryId}/{priceListId}

Parameters:

NameDescriptionTypeRequiredExamples values
customerCategoryIdreference of the customer categoryStringYesCC-002
priceListIdreference of the price listStringYesDL-001

Success Output

Success case: response.status=200
{
    "success": "true",
    "success_description": "Instance deleted successfully"
}

Failure Output

Failure case:response.status = 404
{
    "error": "not_found",
    "error_description": "The customer category price list with the id 999 doesn't exist."
}

Failure case:response.status = 400
{
    "error": "invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}
{
    "error": "delete_failed",
    "error_description": "Failed to delete instance"
}

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

38.4 Update

Service: Update

Description: This web service is used to update an existing customerCategoryPriceLists object to the database

Method: PUT

Request content type: application/json

URL:

https://BASE_URL/api/VERSION/customerCategoryPriceLists

Parameters:

NameDescriptionTypeRequiredExample values
idid of the desired record to updateLongYes123
priceListIdthe id of the priceList to assignLongYes777
customerCategoryIdthe id of the customerCategoryId to assignLongYes111

URL with external_id:

https://BASE_URL/api/VERSION/customerCategoryPriceLists/reference/{customerCategoryId}/{priceListId}

Parameters:

NameDescriptionTypeRequiredExamples values
customerCategoryIdreference of the customer categoryStringYesCC-002
priceListIdreference of the price listStringYesDL-001

Success Output

Success case: response.status=200
{
    "id": 11,
    "priceListReference": "PL-009",
    "customerCategoryReference": "1113",
    "customerCategory": {
        "id": 62,
        "reference": "1113",
        "name": "joe",
        "href": "/api/v1/customerCategories/62"
    },
    "priceList": {
        "id": 10,
        "reference": "PL-009",
        "name": "AddedPriceLIst12 new",
        "href": "/api/v1/priceLists/10"
    },
    "organization": "Lyon",
    "dateCreated": "2016-08-24T10:43:47Z",
    "lastUpdated": "2016-08-24T11:03:26Z"
}

Failure Output

Failure case:response.status = 400
{
    "error": "missing_param",
    "error_description": "priceListId parameter is missing"
}
{
    "error": "already_assigned",
    "error_description": "customerCategory is already assigned to priceList."
}
{
    "error": "invalid_param_type",
    "error_description": "The type of parameter priceListId you provided is not valid for this request."
}
{
     "error": "save_failed",
     "error_description": "Failed to save instance"
}

Failure case:response.status = 404
{
    "error": "not_found",
    "error_description": "The priceList with the id 999 doesn't exist."
}

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

38.5 Create

Service: Save

Description: This web service is used to add a new customerCategoryPriceLists list object into the database

URL:

https://BASE_URL/api/VERSION/customerCategoryPriceLists

Method: POST

Request content type: application/json

Parameters:

NameDescriptionTypeRequiredExample values
priceListIdthe id of the priceList to assignLong/StringYes777
customerCategoryIdthe id of the customerCategory to assignLong/StringYes111
useExternalIdBy default, it is set to false. set it to true if you want to use external ids.Booleannotrue , false

Success Output

Success case: response.status=201
{
    "id": 12,
    "priceListReference": "PL-009",
    "customerCategoryReference": "11133",
    "customerCategory": {
        "id": 63,
        "reference": "11133",
        "name": "joe",
        "href": "/api/v1/customerCategories/63"
    },
    "priceList": {
        "id": 10,
        "reference": "PL-009",
        "name": "AddedPriceLIst12 new",
        "href": "/api/v1/priceLists/10"
    },
    "organization": "Lyon",
    "dateCreated": "2016-08-24T10:55:26Z",
    "lastUpdated": "2016-08-24T10:55:26Z"
}

Failure Output

Failure case:response.status = 400
{
    "error": "missing_param",
    "error_description": "priceListId parameter is missing"
}
{
    "error": "already_assigned",
    "error_description": "customerCategory is already assigned to priceList."
}
{
    "error": "invalid_param_type",
    "error_description": "The type of parameter priceListId you provided is not valid for this request."
}
{
     "error": "save_failed",
     "error_description": "Failed to save instance"
}

Failure case:response.status = 404
{
    "error": "not_found",
    "error_description": "The priceList with the id 999 doesn't exist."
}

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