(Quick Reference)

18 Segmentations of customers - Reference Documentation

Version: 2.1

18.1List

18.2Show

18.3Create

18.4Update

18.5Upsert

18.6Delete

18 Segmentations of customers

18.1 List

Service: List

Description: This web service return the list of customers segments in JSON format

URL:

https://BASE_URL/api/VERSION/customerSegmentations

Method: GET

Parameters:

Pagination parameters:

Name	Description	Type	Required	Possible values
offset	Tells where to start returning records from the entire set of results	Integer	No
max	limits the number of resources requested to return	Integer	No
sort	Orders the results by the specified field	String	No
order	Orders ascending (ASC) or descending (DESC)	Integer	No	asc,desc

Filters parameters:

Name	Description	Type	Required	Example values
dateCreated_gt	Filters by the resource's creation date time and operator greater than	Date	no	2016-08-15T14:52:48Z
dateCreated_gte	Filters by the resource's creation date time and operator greater than or equal	Date	no
dateCreated_lt	Filters by the resource's creation date time and operator less than	Date	no
dateCreated_lte	Filters by the resource's creation date time and operator less than or equal	Date	no
lastUpdated_gt	Filters by the resource's last-modified date time and operator greater than	Date	no
lastUpdated_gte	Filters by the resource's last-modified date time and operator greater than or equal	Date	no
lastUpdated_lt	Filters by the resource's last-modified date time and operator less than	Date	no
lastUpdated_lte	Filters by the resource's last-modified date time and operator less than or equal	Date	no
reference	Wildcard search by the resource's reference	String	no	reference=Ref-6* , reference=ef-6 , reference=ef-6*
name	Wildcard search by the resource's name	String	no

Success Output

Success case: response.status=200

{
    "paging": {
        "total": 3,
        "max": 100,
        "offset": 0,
        "previous": null,
        "next": null
    },
    "data": [
        {
            "id": 1,
            "name": "Segmentation1",
            "reference": "ref-55",
            "organization": "Lyon",
            "description": "",
            "dateCreated": "2016-05-10T16:05:41Z",
            "lastUpdated": "2016-05-10T16:05:41Z"
        },
        {
            "id": 2,
            "name": "Segmentation2",
            "reference": "Ref-88",
            "organization": "Lyon",
            "description": "",
            "dateCreated": "2016-05-10T16:05:58Z",
            "lastUpdated": "2016-05-10T16:05:58Z"
        },
        {
            "id": 3,
            "name": "Segmentation3",
            "reference": "Ref-546",
            "organization": "Lyon",
            "description": "",
            "dateCreated": "2016-05-10T16:06:17Z",
            "lastUpdated": "2016-05-10T16:06:17Z"
        }
    ]
}

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..."
}

18.2 Show

Service: Show

Description: This web service return a customer segment details of the specified id in JSON format

URL:

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

URL with external_id:

https://BASE_URL/api/VERSION/customerSegmentations/reference/{id}

Method: GET

Parameters:

Name	Description	Type	Required	Example values
id	id of the wanted customer segment	Long/String	Yes	777

Success Output

Success case: response.status=200

{
    "id": 3,
    "name": "Segmentation3",
    "reference": "Ref-546",
    "organization": "Lyon",
    "description": "",
    "dateCreated": "2016-05-10T16:06:17Z",
    "lastUpdated": "2016-05-10T16:06:17Z"
}

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 segmentation with the id 3999 doesn't exist."
}

18.3 Create

Service: Save

Description: This web service is used to add a new customer segment object to the database

URL:

https://BASE_URL/api/VERSION/customerSegmentations

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required
reference	the reference of the new segment	String	Yes
name	the name of the new segment	String	Yes
description	some details about the new segment	String	No

reference must be unique

Success Output

Success case: response.status=201

{
    "id": 6,
    "name": "Segmentation 4",
    "reference": "3",
    "organization": "Lyon",
    "description": null,
    "dateCreated": "2016-08-16T08:48:38Z",
    "lastUpdated": "2016-08-16T08:48:38Z"
}

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": "save_failed",
    "error_description": "Failed to save instance"
}

Failure case:response.status = 500

{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}

18.4 Update

Service: Update

Description: This web service is used in order to updates a customer segment object into the database

URL:

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

URL with external_id:

https://BASE_URL/api/VERSION/customerSegmentations/reference/{id}

Method: PUT

Request content type: application/json

Parameters:

Name	Description	Type	Required	Possible values
id	id of the segment to update	Long/String	Yes	777
reference	the reference value	String	Yes
name	the new name value	String	Yes
description	the new description value	String	No

reference must be unique

Success Output

Success case: response.status=200

{
    "id": 4,
    "name": "newSegment 4",
    "reference": "100",
    "organization": "Lyon",
    "description": "description 4",
    "dateCreated": "2016-08-16T08:45:40Z",
    "lastUpdated": "2016-08-16T09:34:13Z"
}

Failure Output

Failure case:response.status = 400

{
    "error": "missing_param",
    "error_description": "reference parameter is missing"
}

{
    "error":"invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}

{
    "error": "not_unique",
    "error_description": "reference already used"
}

{
    "error": "save_failed",
    "error_description": "Failed to save instance"
}

Failure case:response.status = 404

{
    "error": "not_found",
    "error_description": "The customer segmentation with the id 999 doesn't exist."
}

Failure case:response.status = 500

{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}

18.5 Upsert

Service: Upsert

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

URL:

https://BASE_URL/api/VERSION/customerSegmentations/reference/{id}

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Possible values
name	the name of the new segment	String	Yes
description	some details about the new segment	String	No

reference must be unique

Success Output

Success case: response.status=201

{
    "id": 6,
    "name": "Segmentation 4",
    "reference": "3",
    "organization": "Lyon",
    "description": null,
    "dateCreated": "2016-08-16T08:48:38Z",
    "lastUpdated": "2016-08-16T08:48:38Z"
}

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": "save_failed",
    "error_description": "Failed to save instance"
}

Failure case:response.status = 500

{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}

18.6 Delete

Service: Delete

Description: This web service is used in order to delete a customer segment object from the database

URL:

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

URL with external_id:

https://BASE_URL/api/VERSION/customerSegmentations/reference/{id}

Method: DELETE

Parameters:

Name	Description	Type	Required	Example values
id	Id of the desired customer segment to delete	Long/String	Yes	777

Success Output

Success case: response.status=200

{
    "success": "true",
    "success_description": "Instance deleted successfully"
}

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."
}

{
    "error": "delete_failed",
    "error_description": "Failed to delete instance"
}

Failure case:response.status = 404

{
    "error": "not_found",
    "error_description": "The customer segmentation with the id 9999 doesn't exist."
}

Failure case:response.status = 500

{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}

<< 17Categories of customers

19Check-in List >>

18 Segmentations of customers - Reference Documentation

Table of Contents

18 Segmentations of customers

18.1 List

Success Output

Failure Output

18.2 Show

Success Output

Failure Output

18.3 Create

Success Output

Failure Output

18.4 Update

Success Output

Failure Output

18.5 Upsert

Success Output

Failure Output

18.6 Delete

Success Output

Failure Output

Answers

Appointment

Appointment Categories

Attribute values

Attributes

Authentication

Authority

Check In List

Contacts

Customer Categories

Customer Categories Discount Lists

Customer Categories Price Lists

Customer Categories Tax Lists

Customer Discounts

Customer Employee

Customer Group Promotion Lists

Customer Groups

Customer Groups Assign

Customer Price List

Customer Promo List

Customer Segmentations

Customer Tax List

Customers

Deliveries

Discount lists

Employee Groups

Employee Item Category Assign

Employee WareHouses

Employees

Exchange rates

Item Categories

Item Groups

Item Groups Assign

Item attributes

Item category translation

Item customer groups assign

Item group translation

Item translation

Item units

Items

Loading details

Loadings

Objectives

Operation Prepayments

Operation lines

Operation payments

Operations

Payment types

Prepayment Allocations

Price List

Prices

Promotion inputs

Promotion outputs

Promotions

Question Columns

Question Lines

Question options

Questions

Reasons