(Quick Reference)

12 Contacts of customers - Reference Documentation

Version: 2.1

12.1List

12.2Show

12.3Create

12.4Update

12.5Delete

12 Contacts of customers

12.1 List

Service: List of contacts

Description: This web service returns a json list of contacts.

URL:

https://BASE_URL/api/VERSION/contacts

Method: GET

Parameters:

Pagination parameters:

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

The max parameter is set to 100 by default.

Filters parameters:

Name	Description	Type	Required	Possible 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
customerReference	Filters by the customer's reference	String	no
firstName	Filters by the resource's firstName	String	no
lastName	Filters by the resource's lastName	String	no

Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)

Success Output

Success case: response.status=200

{
  "paging": {
    "total": 1,
    "max": 5,
    "offset": 0,
    "previous": null,
    "next": null
  },
  "data": [
    {
      "id": 5,
      "customerReference": "C0959",
      "customer": {
        "id": 3229,
        "reference": "C0959",
        "name": "Marie's Jewelry",
        "href": "/api/v1.0/customers/3229"
      },
      "firstName": "Marie",
      "lastName": "Schrader",
      "mobile": "",
      "fax": "",
      "email": "",
      "fonction": "Commercial",
      "phone": "",
      "phone2": "",
      "comment": "",
      "country": "",
      "city": "",
      "postalCode": "",
      "address": "",
      "isDecisionMaker": true,
      "photo": null,
      "user": {
        "id": 4,
        "reference": "emp-00",
        "href": "/api/v1.0/users/4"
      },
      "organization": "entity1",
      "dateCreated": "2015-12-18T13:21:18Z",
      "lastUpdated": "2016-08-16T13:35:20Z"
    }
  ]
}

To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:

<BASE_URL>/entity1-1450169988465/photoContact/small_1471508040029_2938_marie_schrader.png

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

12.2 Show

Service: Show a contact

Description: Returns the requested contact in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

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

Method: GET

Parameters:

Name	Description	Type	Required	Example values
id	The numerical ID of the desired contact	Long	yes	123

Success Output

Success case: response.status=200

{
  "id": 5,
  "customerReference": "C0959",
  "customer": {
    "id": 3229,
    "reference": "C0959",
    "name": "Marie's Jewelry",
    "href": "/api/v1.0/customers/3229"
  },
  "firstName": "Marie",
  "lastName": "Schrader",
  "mobile": "",
  "fax": "",
  "email": "",
  "fonction": "Commercial",
  "phone": "",
  "phone2": "",
  "comment": "",
  "country": "",
  "city": "",
  "postalCode": "",
  "address": "",
  "isDecisionMaker": true,
  "photo": null,
  "user": {
    "id": 4,
    "reference": "emp-00",
    "href": "/api/v1.0/users/4"
  },
  "organization": "entity1",
  "dateCreated": "2015-12-18T13:21:18Z",
  "lastUpdated": "2016-08-16T13:35:20Z"
}

To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:

<BASE_URL>/entity1-1450169988465/photoContact/small_1471508040029_2938_marie_schrader.png

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

12.3 Create

Service: Create a contact

Description: Returns the created contact in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/contacts

Method: POST

Request content type: application/x-www-form-urlencoded or multipart/form-data

Parameters:

Name	Description	Type	Required	Example values
firstName		String	yes
lastName		String	yes
customerId		Long/String	yes
fonction		String	no
country	ISO county code	String	no	FR
city		String	no
postalCode		String	no
address		String	no
email		String	no
phone		String	no
phone2		String	no
mobile		String	no
fax		String	no
imageFile	Image can be in jpg, gif, png or bmp	Multipart	no
useExternalId	By default, it is set to false. set it to true if you want to use external ids.	Boolean	no	true , false

Success Output

Success case: response.status=201

{
  "id": 5,
  "customerReference": "C0959",
  "customer": {
    "id": 3229,
    "reference": "C0959",
    "name": "Marie's Jewelry",
    "href": "/api/v1.0/customers/3229"
  },
  "firstName": "Marie",
  "lastName": "Schrader",
  "mobile": "",
  "fax": "",
  "email": "",
  "fonction": "Commercial",
  "phone": "",
  "phone2": "",
  "comment": "",
  "country": "",
  "city": "",
  "postalCode": "",
  "address": "",
  "isDecisionMaker": true,
  "photo": null,
  "user": {
    "id": 4,
    "reference": "emp-00",
    "href": "/api/v1.0/users/4"
  },
  "organization": "entity1",
  "dateCreated": "2015-12-18T13:21:18Z",
  "lastUpdated": "2015-12-18T13:21:18Z"
}

To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:

<BASE_URL>/entity1-1450169988465/photoContact/small_1471508040029_2938_marie_schrader.png

Failure Output

Failure case:response.status = 400

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

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

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

{
  "error": "email_validation_error",
  "error_description": "Failed to "+operation+" the contact : incorrect Email format"
}

{
  "error": "country_error",
  "error_description": "Failed to "+operation+" the contact : incorrect country code"
}

{
  "error": "exceeded_file_size",
  "error_description": "image size should not exceed 2Mo
}

{
  "error": "unsupported_file_type",
  "error_description": "image format not supported."
}

Failure case:response.status = 404

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

Failure case:response.status = 500

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

12.4 Update

Service: Update a contact

Description: Returns the updated contact in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

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

Method: POST

Request content type: application/x-www-form-urlencoded or multipart/form-data

Parameters:

Name	Description	Type	Required	Example values
id	The numerical ID of the desired contact	Long	yes	123
firstName		String	yes
lastName		String	yes
customerId		Long/String	yes
fonction		String	no
country	ISO county code	String	no	FR
city		String	no
postalCode		String	no
address		String	no
email		String	no
phone		String	no
phone2		String	no
mobile		String	no
fax		String	no
imageFile	Image can be in jpg, gif, png or bmp format	Multipart	no
useExternalId	By default, it is set to false. set it to true if you want to use external ids.	Boolean	no	true , false

Success Output

Success case: response.status=200

{
  "id": 5,
  "customerReference": "C0959",
  "customer": {
    "id": 3229,
    "reference": "C0959",
    "name": "Marie's Jewelry",
    "href": "/api/v1.0/customers/3229"
  },
  "firstName": "Marie",
  "lastName": "Schrader",
  "mobile": "",
  "fax": "",
  "email": "",
  "fonction": "Commercial",
  "phone": "",
  "phone2": "",
  "comment": "",
  "country": "",
  "city": "Any town",
  "postalCode": "",
  "address": "Main street",
  "isDecisionMaker": true,
  "photo": "BASE_URL/entity1-1450169988465/photoContact/1471508040029_2938_marie_schrader.png",
  "user": {
    "id": 4,
    "reference": "emp-00",
    "href": "/api/v1.0/users/4"
  },
  "organization": "entity1",
  "dateCreated": "2015-12-18T13:21:18Z",
  "lastUpdated": "2016-08-16T13:35:20Z"
}

To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:

<BASE_URL>/entity1-1450169988465/photoContact/small_1471508040029_2938_marie_schrader.png

Failure Output

Failure case:response.status = 400

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

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

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

{
  "error": "email_validation_error",
  "error_description": "Failed to "+operation+" the contact : incorrect Email format"
}

{
  "error": "country_error",
  "error_description": "Failed to "+operation+" the contact : incorrect country code"
}

{
  "error": "exceeded_file_size",
  "error_description": "image size should not exceed 2Mo
}

{
  "error": "unsupported_file_type",
  "error_description": "image format not supported."
}

Failure case:response.status = 404

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

Failure case:response.status = 500

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

12.5 Delete

Service: Delete a contact

Description: Returns a json response.

URL:

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

Method: DELETE

Parameters:

Name	Description	Type	Required	Example values
id	The numerical ID of the desired contact	Long	yes	123

Success Output

Success case: response.status=200

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

Failure Output

Failure case:response.status = 400

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

Failure case:response.status = 404

{
  "error": "not_found",
  "error_description": "The contact with the id 706 doesn't exist."
}

<< 11Customers

13Payment types >>

12 Contacts of customers - Reference Documentation

Table of Contents

12 Contacts of customers

12.1 List

Success Output

Failure Output

12.2 Show

Success Output

Failure Output

12.3 Create

Success Output

Failure Output

12.4 Update

Success Output

Failure Output

12.5 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

Regions

Reports

Return details