(Quick Reference)
Service: List of customers Description: This web service returns a list of customers in JSON format URL: https://BASE_URL/api/v1.0/customers : GET 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. Filter parameters:
| Name | Description | Type | Required | Possible values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | | | 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=*ef-6* | | name | Wildcard search by the resource's name | String | no | | | categoryReference | Wildcard search by the resource's category reference | String | no | categoryReference=Ref-6* , categoryReference=*ef-6 , categoryReference=*ef-6* | | isActive | Filters by the resource's status | Boolean | no | true, false |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output Success case: response.status=200
{
"paging": {
"total": 1019,
"max": 2,
"offset": 0,
"previous": null,
"next": "/api/v1.0/customers?max=2&offset=2&sort=dateCreated&order=asc"
},
"data": [
{
"id": 256,
"reference": "NC-3",
"reference2": null,
"name": "Marie's Jewelry",
"categoryReference": "jewelry",
"customerCategory": {
"id": 2,
"reference": "jewelry",
"name": "Home",
"href": "/api/v1.0/customerCategories/2"
},
"isSubCustomer": false,
"parentCustomer": null,
"billWithParent": true,
"customerSegmentationReference": "seg_a",
"customerSegmentation": {
"id": 1,
"reference": "seg_a",
"name": "Segmentation A",
"href": "/api/v1.0/customerSegmentations/1"
},
"pocTenus": null,
"email": null,
"logo": null,
"phone": null,
"mobile": null,
"fax": null,
"comment": null,
"barcode": null,
"isSameAddress": true,
"billingCountry": "FR",
"billingCity": "Nice",
"billingPostalCode": null,
"billingAddress": null,
"billingLat": null,
"billingLng": null,
"country": "FR",
"city": "Nice",
"postalCode": null,
"address": null,
"latitude": null,
"longitude": null,
"isCredit": null,
"creditLimit": 5000,
"balance": null,
"maxChequePeriod": null,
"maxChequeValue": null,
"appliedCashBackOutput": null,
"returnDiscount": null,
"invoicesPerRoute": null,
"isActive": true,
"onHold": false,
"onHoldReason": null,
"paymentTerm": null,
"createdBy": {
"userId": 2,
"reference": "emp-002",
"href": "/api/v1.0/users/2"
},
"dueDateConfigNumber": 3,
"dueDateConfigType": "daysAfterInvoiceDate",
"paymentTypes": [],
"website": null,
"taxNumber": null,
"companyRegistrationNumber": null,
"contacts": [],
"currency": "EUR",
"organization": "entity1",
"dateCreated": "2015-12-17T23:00:00Z",
"lastUpdated": "2015-12-17T23:00:00Z",
"region": null
},
…
]
}
To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:
If geographical locations is activated in organization, region field will be returned.
<BASE_URL>/entity1-1450169988465/photoCustomer/small_471338230737_logo_color_272x92dp.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..."
}
|
|
