Любой заказ в системе может быть привязан к покупателю.
Получение списка покупателей
Авторизация требуется. Входных параметров нет.
GET /v1.0/customers
Для запроса доступна сортировка и пагинация. Доступные поля сортировки: default (CompanyName,LastName,FirstName), name (LastName,FirstName), company (CompanyName). Значения параметров сортировки и пагинации по умолчанию: sortby=default&direction=asc&offset=0&limit=100.
В данном запросе возможно указать параметр type=company (type=person) для выборки только юридических (физических) лиц. Если параметр не указан или не совпадает с одним из {company, person}, тогда будут выбраны все клиенты (и юр. лица, и физ. лица).
В запросе имеется опциональный параметр archived=false (archived=true) - для вывода не архивных записей (архивных записей . По умолчанию в запросе выводятся все записи - и архивные и не архивные.
Возвращает массив customers:
{
"customers": [
{
"_id": 8,
"description": "test",
"email": "cust@mail.ru",
"name": "My first name",
"lastname":"My last name",
"companyname": "Google",
"phone": "123-12-12",
"status": 0,
"archived": false,
"archivationdate": 0,
"crmid": "",
"refid": ""
}]}
Получение покупателя по ID
Авторизация требуется. Входных параметров нет.
GET /v1.0/customers/{id}
Возвращает объект customer:
{
"customer": {
"_id": 4,
"archivationdate": 0,
"archived": false,
"companyname": "",
"description": "",
"email": "mail@mail.ru",
"lastname": "",
"name": "Petay",
"phone": "8",
"status": 1,
"crmid": "",
"refid": ""
}
}
Создание нового покупателя
Авторизация требуется. Входные параметры RAW JSON:
{
" customerName" : "My first name",
"customerLastName": "My last name",
"customerEmail" : "postman@mail.ru",
"customerCompanyName": "Google",
"customerPhone" : "123-11-11",
"customerDescription" : "Created by postman",
"customerStatus" : 0,
"archived": false,
"crmId": "",
"refId": ""
}
POST /v1.0/customers
Возвращает элемент customer
{
"customer": {
"_id": 9,
"description": "Created by postman",
"email": "postman@mail.ru",
"name": "PostMan",
"lastname":"My last name",
"companyname": "Google",
"phone": "123-11-11",
"status": 0,
"archived": false,
"archivationdate": 0,
"crmid": "",
"refid": ""
}
}
Изменение покупателя
Авторизация требуется. Входные параметры RAW JSON:
{
"customerName" : "PostManPut",
"customerLastName": "My last name",
"customerEmail" : "postman@yandex.ru",
"customerCompanyName": "Google",
"customerPhone" : "111-11-11",
"customerDescription" : "Created by postman By",
"customerStatus" : 1,
"archived": false,
"crmId": "",
"refId": ""
}
PUT /v1.0/customers/{id}
Возвращает элемент customer:
{
"customer": {
"_id": 9,
"description": "Created by postman By",
"email": "postman@yandex.ru",
"name": "PostManPut",
"lastname":"My last name",
"companyname": "Google",
"phone": "111-11-11",
"status": 1,
"archived": false,
"archivationdate": 0,
"crmid": "",
"refid": ""
}}
Удаление покупателя
Авторизация требуется. Входных параметров нет.
DELETE /v1.0/customers/{id}
Получение списка заказов покупателя
Авторизация требуется.
GET /v1.0/customers/{id}/orders
Для запроса доступна сортировка и пагинация. Доступные поля сортировки: number, submitdate. Значения параметров сортировки и пагинации по умолчанию: sortby=number&direction=asc&offset=0&limit=100.
Для запроса доступна фильтрацию по статусу заказа: Draft(0), Submit(1), Revoked(2). По умолчанию в запросе выдаются заказы с любыми статусами. Если необходимо выбрать заказы с определенными статусами - перечислите их через запятую в параметре запроса "status". Например, указав status=0,1 - получите только заказы в статусе Draft(0) и Submit(1).
Возвращает массив orders:
{
"orders": [
{
"_id": 10016,
"activationbirthdate": 0,
"activationdeathdate": 0,
"activationlimit": 7,
"archivationdate": 0,
"archived": false,
"canoverwritecontainer": false,
"customerrequired": true,
"date": 1527501148,
"description": "With client",
"isdemo": false,
"number": 0,
"quantity": 2,
"status": 0,
"submitdate": 0,
"type": 0,
"crmid": "",
"refid": ""
},
{
"_id": 10096,
"activationbirthdate": 1538463338,
"activationdeathdate": 0,
"activationlimit": 1,
"archivationdate": 0,
"archived": false,
"canoverwritecontainer": false,
"customerrequired": true,
"date": 1538463338,
"description": "test bugs in sn activation number",
"isdemo": false,
"number": 0,
"quantity": 10,
"status": 1,
"submitdate": 0,
"type": 0,
"crmid": "",
"refid": ""
}
]
}
