SNARTA

info@snarta.com

+7 499 677-22-98

Клиенты

Свойства клиента

id - идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

name - наименование клиента

  • Строка
  • Обязательно к заполнению

status - статус клиента

  • Натуральное число
  • Обязательно к заполнению
  • Допустимые значения:
    • 0 - Активный
    • 1 - Заблокирован

price_col - номер колонки с ценами товаров

  • Натуральное число
  • Обязательно к заполнению
  • Максимальное значение - 32767

price_promo_col - номер колонки с ценами товаров со скидками

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию - 0
  • Минимальное значение - 0
  • Максимальное значение - 32767

price_retail_col - номер колонки с розничной ценой товаров (розничная цена)

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию — null
  • Максимальное значение - 32767

debt - дебиторская задолженность в копейках

  • Натуральное число
  • Обязательно к заполнению
  • Минимальное значение (задолженность отсутствует) - 0
  • Максимальное значение - 2147483647

debt_stale - просроченная дебиторская задолженность в копейках

  • Натуральное число
  • Обязательно к заполнению
  • Минимальное значение (задолженность отсутствует) - 0
  • Максимальное значение - 2147483647

debt_stale_limit - максимально допустимая просроченная дебиторская задолженность в копейках

  • Натуральное число
  • Обязательно к заполнению
  • Минимальное значение (ограничение отсутствует) - 0
  • Максимальное значение - 2147483647

Показать список клиентов

GET /v2/customers

page — номер страницы результатов запроса

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию — 1

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

curl --request GET \
  --url 'https://api.snarta.com/v2/customers' \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'
curl --request GET \
  --url 'https://api.snarta.com/v2/customers?page=3' \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

Успешный ответ

{
  "customers": [
    {
      "id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
      "name": "ООО Брэд Пит",
      "status": 0,
      "price_col": 1,
      "price_promo_col": 777,
      "debt": 123456,
      "debt_stale": 0,
      "debt_stale_limit": 0
    }
  ]
}

Показать клиента

GET /v2/customers/[id]

Параметры URL

id — идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

Пример запроса

curl --request GET \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

Успешный ответ

{
  "customer": {
    "id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "name": "ООО Брэд Пит",
    "status": 0,
    "price_col": 1,
    "price_promo_col": 777,
    "debt": 123456,
    "debt_stale": 0,
    "debt_stale_limit": 0
  }
}

Ответы с ошибкой

{}

Создать клиента

POST /v2/customers

Пример запроса

curl --request POST \
  --url https://api.snarta.com/v2/customers \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "name": "ООО Брэд Пит",
    "status": 0,
    "price_col": 1,
    "debt": 123456,
    "debt_stale": 0,
    "debt_stale_limit": 0
}'

Успешный ответ

{
  "customer": {
    "id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "name": "ООО Брэд Пит",
    "status": 0,
    "price_col": 1,
    "price_promo_col": 0,
    "debt": 123456,
    "debt_stale": 0,
    "debt_stale_limit": 0
  }
}

Ответы с ошибкой

{
  "id": "The id field is required.", 
  "name": "The name must be a string."
}
{
  "id": "Duplicate value."
}

Изменить клиента

PUT /v2/customers/[id]

Параметры URL

id — идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

Пример запроса

curl --request PUT \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "ООО Брэд Пит",
  "status": 0,
  "price_col": 1,
  "price_promo_col": 777,
  "debt": 123456,
  "debt_stale": 0,
  "debt_stale_limit": 0
}'

Успешный ответ

{
  "customer": {
    "id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "name": "ООО Брэд Пит",
    "status": 0,
    "price_col": 1,
    "price_promo_col": 777,
    "debt": 123456,
    "debt_stale": 0,
    "debt_stale_limit": 0
  }
}

Ответы с ошибкой

{
  "id": "The id field is required.",
  "name": "The name must be a string."
}
{}