Customer

INFO

Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.

POST /customer/create

This method allows adding customer into the account.

Тело запроса

Поле	Тип	Обязательно	Описание
`name`	`string`	Да
`type`	`string`	Нет	type customer. Допустимые значения: `legal`, `natural`
`category_id`	`string`	Нет
`state`	`string`	Нет	Допустимые значения: `new`, `warning`, `black_list`, `active`
`inn`	`string`	Нет
`director_name`	`string`	Нет
`address`	`string`	Нет
`delivery_address`	`object`	Нет
`delivery_address.long`	`number`	Нет
`delivery_address.lat`	`number`	Нет
`delivery_address.human_address`	`object`	Нет
`delivery_address.human_address.address`	`string`	Нет	По умолчанию: `"string"`
`delivery_address.human_address.city`	`string`	Нет	По умолчанию: `"string"`
`delivery_address.human_address.state`	`string`	Нет	По умолчанию: `"string"`
`delivery_address.human_address.zip`	`string`	Нет	По умолчанию: `"string"`
`bank_name`	`string`	Нет
`agent_id`	`string`	Нет
`responsible_id`	`string`	Нет
`account_number`	`string`	Нет
`mfo`	`string`	Нет
`loyalty_card_id`	`string`	Нет
`qqs_number`	`string`	Нет
`phone_number`	`string`	Нет
`phone_numbers`	`string[]`	Нет
`company_phone_number`	`string`	Нет
`description`	`string`	Нет
`organization_ids`	`string[]`	Да
`debt_limits`	`object`	Нет
`debt_limits.organization_id`	`string`	Нет
`debt_limits.limit`	`number`	Нет
`debt_limits.customer_id`	`string`	Нет
`organization_id`	`string`	Нет
`person_id`	`string`	Нет
`oked`	`string`	Нет
`gender`	`string`	Нет	Допустимые значения: `male`, `female`
`image`	`string`	Нет
`last_name`	`string`	Нет
`middle_name`	`string`	Нет
`birth_date`	`string`	Нет
`legal_person_id`	`string`	Нет
`telegram_link`	`string`	Нет
`is_supplier`	`boolean`	Нет	По умолчанию: `false`
`status`	`string`	Нет	Допустимые значения: `active`, `inactive`
`short_name`	`string`	Нет
`web_site`	`string`	Нет
`code`	`string`	Нет
`postal_code`	`string`	Нет
`owner_id`	`string`	Нет
`manager_id`	`string`	Нет
`custom_fields`	`object`	Нет
`custom_fields._id`	`string`	Нет
`custom_fields.value`	`any`	Нет

json

{
  "name": "string",
  "type": "legal",
  "category_id": "string",
  "state": "new",
  "inn": "string",
  "director_name": "string",
  "address": "string",
  "delivery_address": {
    "long": 0,
    "lat": 0,
    "human_address": {
      "address": "string",
      "city": "string",
      "state": "string",
      "zip": "string"
    }
  },
  "bank_name": "string",
  "agent_id": "string",
  "responsible_id": "string",
  "account_number": "string",
  "mfo": "string",
  "loyalty_card_id": "string",
  "qqs_number": "string",
  "phone_number": "string",
  "phone_numbers": [
    "string"
  ],
  "company_phone_number": "string",
  "description": "string",
  "organization_ids": [
    "string"
  ],
  "debt_limits": {
    "organization_id": "string",
    "limit": 0,
    "customer_id": "string"
  },
  "organization_id": "string",
  "person_id": "string",
  "oked": "string",
  "gender": "male",
  "image": "string",
  "last_name": "string",
  "middle_name": "string",
  "birth_date": "string",
  "legal_person_id": "string",
  "telegram_link": "string",
  "is_supplier": false,
  "status": "active",
  "short_name": "string",
  "web_site": "string",
  "code": "string",
  "postal_code": "string",
  "owner_id": "string",
  "manager_id": "string",
  "custom_fields": {
    "_id": "string",
    "value": null
  }
}

Ответ

Поле	Тип	Описание
`_id`	`string`	id of customer
`created_at`	`string`
`updated_at`	`string`
`name`	`string`
`type`	`string`
`inn`	`string`
`director_name`	`string`
`address`	`string`
`bank_name`	`string`
`account_number`	`string`
`pinfl`	`string`
`director_pinfl`	`string`
`mfo`	`string`
`oked`	`string`
`qqs_number`	`string`
`phone_number`	`string`
`phone_numbers`	`string[]`
`company_phone_number`	`string`
`description`	`string`
`organization_ids`	`string[]`
`last_sale_at`	`string`
`first_sale_at`	`string`
`total_sale`	`number`
`avg_sale`	`number`
`point`	`number`
`balance`	`number`
`balance_currency_id`	`string`
`balances`	`object`
`balances.balance`	`number`
`balances.balance_currency_id`	`string`
`balance_list`	`object[]`

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "created_at": "string",
    "updated_at": "string",
    "name": "string",
    "type": "string",
    "inn": "string",
    "director_name": "string",
    "address": "string",
    "bank_name": "string",
    "account_number": "string",
    "pinfl": "string",
    "director_pinfl": "string",
    "mfo": "string",
    "oked": "string",
    "qqs_number": "string",
    "phone_number": "string",
    "phone_numbers": [
      "string"
    ],
    "company_phone_number": "string",
    "description": "string",
    "organization_ids": [
      "string"
    ],
    "last_sale_at": "string",
    "first_sale_at": "string",
    "total_sale": 0,
    "avg_sale": 0,
    "point": 0,
    "balance": 0,
    "balance_currency_id": "string",
    "balances": {
      "balance": 0,
      "balance_currency_id": "string"
    },
    "balance_list": [
      {}
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /customer/update

This method allows updating customer in the account.

Тело запроса

Поле	Тип	Обязательно	Описание
`name`	`string`	Да
`type`	`string`	Нет	type customer. Допустимые значения: `legal`, `natural`
`category_id`	`string`	Нет
`state`	`string`	Нет	Допустимые значения: `new`, `warning`, `black_list`, `active`
`inn`	`string`	Нет
`director_name`	`string`	Нет
`address`	`string`	Нет
`delivery_address`	`object`	Нет
`delivery_address.long`	`number`	Нет
`delivery_address.lat`	`number`	Нет
`delivery_address.human_address`	`object`	Нет
`delivery_address.human_address.address`	`string`	Нет	По умолчанию: `"string"`
`delivery_address.human_address.city`	`string`	Нет	По умолчанию: `"string"`
`delivery_address.human_address.state`	`string`	Нет	По умолчанию: `"string"`
`delivery_address.human_address.zip`	`string`	Нет	По умолчанию: `"string"`
`bank_name`	`string`	Нет
`agent_id`	`string`	Нет
`responsible_id`	`string`	Нет
`account_number`	`string`	Нет
`mfo`	`string`	Нет
`loyalty_card_id`	`string`	Нет
`qqs_number`	`string`	Нет
`phone_number`	`string`	Нет
`phone_numbers`	`string[]`	Нет
`company_phone_number`	`string`	Нет
`description`	`string`	Нет
`organization_ids`	`string[]`	Да
`debt_limits`	`object`	Нет
`debt_limits.organization_id`	`string`	Нет
`debt_limits.limit`	`number`	Нет
`debt_limits.customer_id`	`string`	Нет
`organization_id`	`string`	Нет
`person_id`	`string`	Нет
`oked`	`string`	Нет
`gender`	`string`	Нет	Допустимые значения: `male`, `female`
`image`	`string`	Нет
`last_name`	`string`	Нет
`middle_name`	`string`	Нет
`birth_date`	`string`	Нет
`legal_person_id`	`string`	Нет
`telegram_link`	`string`	Нет
`is_supplier`	`boolean`	Нет	По умолчанию: `false`
`status`	`string`	Нет	Допустимые значения: `active`, `inactive`
`short_name`	`string`	Нет
`web_site`	`string`	Нет
`code`	`string`	Нет
`postal_code`	`string`	Нет
`owner_id`	`string`	Нет
`manager_id`	`string`	Нет
`custom_fields`	`object`	Нет
`custom_fields._id`	`string`	Нет
`custom_fields.value`	`any`	Нет
`_id`	`string`	Да	id of customer

json

{
  "name": "string",
  "type": "legal",
  "category_id": "string",
  "state": "new",
  "inn": "string",
  "director_name": "string",
  "address": "string",
  "delivery_address": {
    "long": 0,
    "lat": 0,
    "human_address": {
      "address": "string",
      "city": "string",
      "state": "string",
      "zip": "string"
    }
  },
  "bank_name": "string",
  "agent_id": "string",
  "responsible_id": "string",
  "account_number": "string",
  "mfo": "string",
  "loyalty_card_id": "string",
  "qqs_number": "string",
  "phone_number": "string",
  "phone_numbers": [
    "string"
  ],
  "company_phone_number": "string",
  "description": "string",
  "organization_ids": [
    "string"
  ],
  "debt_limits": {
    "organization_id": "string",
    "limit": 0,
    "customer_id": "string"
  },
  "organization_id": "string",
  "person_id": "string",
  "oked": "string",
  "gender": "male",
  "image": "string",
  "last_name": "string",
  "middle_name": "string",
  "birth_date": "string",
  "legal_person_id": "string",
  "telegram_link": "string",
  "is_supplier": false,
  "status": "active",
  "short_name": "string",
  "web_site": "string",
  "code": "string",
  "postal_code": "string",
  "owner_id": "string",
  "manager_id": "string",
  "custom_fields": {
    "_id": "string",
    "value": null
  },
  "_id": "string"
}

Ответ

Структура ответа совпадает с POST /customer/create.

DELETE /customer/delete/{id}

Delete a customer

Параметры пути

Параметр	Тип	Обязательно	Описание
`id`	`string`	Да

Тело запроса

Тело запроса не требуется.

Ответ

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "ok",
  "time": "2025-05-01T12:00:00Z"
}

GET /customer/get-by-id/{id}

Get customer using its _id

Параметры пути

Параметр	Тип	Обязательно	Описание
`id`	`string`	Да

Тело запроса

Тело запроса не требуется.

Ответ

Структура ответа совпадает с POST /customer/create.

POST /customer/get-paging

Get customers by paging

Тело запроса

Поле	Тип	Обязательно	Описание
`page`	`number`	Да	По умолчанию: `1`
`limit`	`number`	Да	По умолчанию: `20`
`updated_at`	`string`	Нет
`organization_id`	`string`	Нет
`search`	`string`	Нет
`phone_number`	`string`	Нет

json

{
  "page": 1,
  "limit": 20,
  "updated_at": "string",
  "organization_id": "string",
  "search": "string",
  "phone_number": "string"
}

Ответ

data.total — общее количество записей, data.data[] — записи текущей страницы. Таблица ниже описывает одну запись.

Поле	Тип	Описание
`_id`	`string`	id of customer
`created_at`	`string`
`updated_at`	`string`
`name`	`string`
`type`	`string`
`inn`	`string`
`director_name`	`string`
`address`	`string`
`bank_name`	`string`
`account_number`	`string`
`pinfl`	`string`
`director_pinfl`	`string`
`mfo`	`string`
`oked`	`string`
`qqs_number`	`string`
`phone_number`	`string`
`phone_numbers`	`string[]`
`company_phone_number`	`string`
`description`	`string`
`organization_ids`	`string[]`
`last_sale_at`	`string`
`first_sale_at`	`string`
`total_sale`	`number`
`avg_sale`	`number`
`point`	`number`
`balance`	`number`
`balance_currency_id`	`string`
`balances`	`object`
`balances.balance`	`number`
`balances.balance_currency_id`	`string`
`balance_list`	`object[]`

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "_id": "string",
        "created_at": "string",
        "updated_at": "string",
        "name": "string",
        "type": "string",
        "inn": "string",
        "director_name": "string",
        "address": "string",
        "bank_name": "string",
        "account_number": "string",
        "pinfl": "string",
        "director_pinfl": "string",
        "mfo": "string",
        "oked": "string",
        "qqs_number": "string",
        "phone_number": "string",
        "phone_numbers": [
          "string"
        ],
        "company_phone_number": "string",
        "description": "string",
        "organization_ids": [
          "string"
        ],
        "last_sale_at": "string",
        "first_sale_at": "string",
        "total_sale": 0,
        "avg_sale": 0,
        "point": 0,
        "balance": 0,
        "balance_currency_id": "string",
        "balances": {
          "balance": 0,
          "balance_currency_id": "string"
        },
        "balance_list": [
          {}
        ]
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

GET /customer/get-deleted

Get deleted customer ids

Параметры запроса

Параметр	Тип	Обязательно	Описание
`deleted_at`	`string`	Да

Тело запроса

Тело запроса не требуется.

Ответ

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    "string"
  ],
  "time": "2025-05-01T12:00:00Z"
}

PUT /customer/set-state

setState customer

Тело запроса

Поле	Тип	Обязательно	Описание
`_id`	`string`	Да
`state`	`string`	Да	Допустимые значения: `black_list`, `new`, `active`, `warning`

json

{
  "_id": "64b7f4d9e2b3b6a0b7c5d80a",
  "state": "new"
}

Ответ

Структура ответа совпадает с POST /customer/create.

GET /customer/get-by-phone-number

Find a customer by phone number.

Параметры запроса

Параметр	Тип	Обязательно	Описание
`phone_number`	`string`	Да

Тело запроса

Тело запроса не требуется.

Ответ

Структура ответа совпадает с POST /customer/create.

Эта страница сгенерирована из спецификации OpenAPI.

Customer ​

POST /customer/create ​

PUT /customer/update ​

DELETE /customer/delete/{id} ​

GET /customer/get-by-id/{id} ​

POST /customer/get-paging ​

GET /customer/get-deleted ​

PUT /customer/set-state ​

GET /customer/get-by-phone-number ​

Customer

POST /customer/create

PUT /customer/update

DELETE /customer/delete/{id}

GET /customer/get-by-id/{id}

POST /customer/get-paging

GET /customer/get-deleted

PUT /customer/set-state

GET /customer/get-by-phone-number