Покупатели
Покупатели магазина с контактами, согласием на рассылки и адресной книгой. Всё это — персональные данные под scope customers:read.
Покупатели
Объекты
Customer
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
external_idstring или nullобязательноВнешний id покупателя — его id в вашей системе; null, если не задан. После слияния двух покупателей ID поглощённого тоже находит выжившего; в ответе — основной ID.
versionintegerобязательноВерсия записи: растёт с каждым изменением. Чтобы изменить запись, передайте её как ETag в If-Match.
namestring или nullобязательноИмя покупателя; null, если неизвестно.
phonestring или nullобязательноОсновной телефон покупателя в формате E.164, например +5491123456789; null, если неизвестен.
emailstring или nullобязательноEmail покупателя; null, если неизвестен.
languagestringобязательноЯзык, на котором магазин пишет покупателю: ru, en или es.
- Значения:
ruenes
is_blockedbooleanобязательноМагазин заблокировал покупателя: войти на витрину он не может.
marketing_consentsмассив objectобязательноСогласие на рекламу по каналам (email, telegram, whatsapp, instagram): строка канала, где покупатель явно согласился (subscribed) или отказался (unsubscribed), и момент последнего явного согласия. Канала нет — согласие подразумеваемое: магазин с marketing_consent_mode: opt_out пишет в такой канал, с opt_in — нет. В WhatsApp — только при subscribed.
Поля · 3
channelstringобязательноКанал рекламы: email, telegram, whatsapp или instagram.
- Значения:
emailtelegramwhatsappinstagram
statusstringобязательноsubscribed — покупатель явно согласился на рекламу в канале, unsubscribed — отказался.
- Значения:
subscribedunsubscribed
consented_atstring (date-time) или nullобязательноКогда покупатель последний раз явно согласился на рекламу в канале; отказ это время не стирает. null, если не соглашался.
accepts_marketingbooleanобязательноУстарело, см. marketing_consents: покупатель не отписался от рекламы по почте.
marketing_consent_atstring (date-time) или nullобязательноУстарело, см. marketing_consents: когда покупатель явно согласился на рекламу по почте; null, если не соглашался.
balanceintegerобязательноБаланс покупателя в магазине: им можно оплачивать заказы. В минимальных единицах валюты магазина.
addressesмассив objectобязательноАдресная книга покупателя, её размер ограничивает магазин. Удалённого адреса просто нет в списке.
Поля · 15
idintegerобязательноID адреса.
customer_idintegerобязательноID покупателя, которому принадлежит адрес.
labelstring или nullобязательноНазвание адреса, например «Дом» или «Работа»; null, если не задано.
streetstringобязательноУлица.
housestring или nullобязательноНомер дома.
apartmentstring или nullобязательноКвартира или офис.
floorstring или nullобязательноЭтаж.
entrancestring или nullобязательноПодъезд.
districtstring или nullобязательноРайон.
postal_codestring или nullобязательноПочтовый индекс.
commentstring или nullобязательноКомментарий для курьера, например как пройти; null, если не задан.
locationobject или nullобязательноТочка адреса на карте; null, если адрес перенесён из другой системы и ещё не уточнён.
Поля · 2
latnumberобязательноШирота в градусах.
lngnumberобязательноДолгота в градусах.
is_defaultbooleanобязательноОсновной адрес покупателя. Когда основной адрес удаляют, основным становится самый свежий.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
group_idsмассив integerобязательноГруппы покупателя по возрастанию id. Членство пишут команды группы: его смена сдвигает покупателя в ленте и шлёт customer.updated, а version и updated_at не меняет.
wholesale_price_list_idinteger или nullобязательноОптовый прайс-лист покупателя-юрлица: по нему считаются его оптовые продажи. null — оптом по базовым ценам. Сам лист виден только с costs:read.
merged_into_customer_idinteger или nullобязательноПокупатель, в которого влит этот: ему перешли контакты, адреса и заказы. null, если не влит.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
deleted_atstring (date-time) или nullобязательноКогда запись отправлена в архив; null у живой записи.
Методы
Покупатели, изменённые с указанного момента: контакты, согласие на рассылки, адреса и группы; поиск по телефону, email и группе
get/customers
Scope: customers:read
Параметры
Строка запроса
limitintegerРазмер страницы: до 250 записей; по умолчанию 50.
- Минимум:
- 1
- Максимум:
- 250
cursorstringНепрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.
- Макс. длина:
- 4096
updated_sincestring (date-time)Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.
- Шаблон:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.
phonestringТолько покупатели с этим телефоном в формате E.164.
- Макс. длина:
- 32
emailstringТолько покупатели с этим email.
- Макс. длина:
- 254
group_idintegerТолько покупатели этой группы — её состав сейчас.
- Минимум:
- 1
wholesale_price_list_idintegerТолько покупатели, которым назначен этот оптовый прайс-лист.
- Минимум:
- 1
Ответы
200Успешно
application/json
Записи страницы.
deletedмассив objectобязательноЗаписи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.
Поля · 2
idintegerобязательноID стёртой записи.
deleted_atstring (date-time)обязательноКогда запись стёрта.
next_cursorstring или nullобязательноКурсор следующей страницы; null на последней.
has_morebooleanобязательноtrue, если есть следующая страница.
sync_cursorstring или nullобязательноНа последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/customers" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"external_id": "string",
"version": 0,
"name": "string",
"phone": "string",
"email": "string",
"language": "ru",
"is_blocked": true,
"marketing_consents": [
{
"channel": "email",
"status": "subscribed",
"consented_at": "2026-01-15T12:00:00Z"
}
],
"accepts_marketing": true,
"marketing_consent_at": "2026-01-15T12:00:00Z",
"balance": 0,
"addresses": [
{
"id": 0,
"customer_id": 0,
"label": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"postal_code": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"is_default": true,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"group_ids": [
0
],
"wholesale_price_list_id": 0,
"merged_into_customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Создать покупателя: имя и хотя бы один контакт
post/customers
Scope: customers:write
Параметры
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
namestringобязательноИмя покупателя; null, если неизвестно.
- Макс. длина:
- 120
- Шаблон:
\S
languagestringЯзык, на котором магазин пишет покупателю: ru, en или es.
- Значения:
ruenes
phonestringОсновной телефон покупателя в формате E.164, например +5491123456789; null, если неизвестен.
- Макс. длина:
- 32
emailstringEmail покупателя; null, если неизвестен.
- Макс. длина:
- 254
external_idstring или nullВнешний id покупателя — его id в вашей системе; null, если не задан. После слияния двух покупателей ID поглощённого тоже находит выжившего; в ответе — основной ID.
Ответы
201Создано
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
Locationstring (uri)обязательноАдрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.
application/json
Возвращает Customer
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
customer_contact_in_useКонтакт уже у покупателя магазина - 409
external_id_in_useВнешний id занят - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/customers" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"name": "string",
"language": "ru",
"phone": "string",
"email": "string",
"external_id": "string"
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": "string",
"phone": "string",
"email": "string",
"language": "ru",
"is_blocked": true,
"marketing_consents": [
{
"channel": "email",
"status": "subscribed",
"consented_at": "2026-01-15T12:00:00Z"
}
],
"accepts_marketing": true,
"marketing_consent_at": "2026-01-15T12:00:00Z",
"balance": 0,
"addresses": [
{
"id": 0,
"customer_id": 0,
"label": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"postal_code": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"is_default": true,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"group_ids": [
0
],
"wholesale_price_list_id": 0,
"merged_into_customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Покупатель
get/customers/{customer}
Scope: customers:read
Параметры
Путь
customerintegerобязательноID покупателя.
Ответы
200Успешно
Заголовки
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Customer
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/customers/{customer}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"external_id": "string",
"version": 0,
"name": "string",
"phone": "string",
"email": "string",
"language": "ru",
"is_blocked": true,
"marketing_consents": [
{
"channel": "email",
"status": "subscribed",
"consented_at": "2026-01-15T12:00:00Z"
}
],
"accepts_marketing": true,
"marketing_consent_at": "2026-01-15T12:00:00Z",
"balance": 0,
"addresses": [
{
"id": 0,
"customer_id": 0,
"label": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"postal_code": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"is_default": true,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"group_ids": [
0
],
"wholesale_price_list_id": 0,
"merged_into_customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Изменить имя, язык и внешний id покупателя
patch/customers/{customer}
Scope: customers:write
Параметры
Путь
customerintegerобязательноID покупателя.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringобязательноETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.
- Пример:
"7"
Тело запроса application/json
namestringИмя покупателя; null, если неизвестно.
- Макс. длина:
- 120
- Шаблон:
\S
languagestringЯзык, на котором магазин пишет покупателю: ru, en или es.
- Значения:
ruenes
external_idstring или nullВнешний id покупателя — его id в вашей системе; null, если не задан. После слияния двух покупателей ID поглощённого тоже находит выжившего; в ответе — основной ID.
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Customer
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
customer_contact_in_useКонтакт уже у покупателя магазина - 409
external_id_in_useВнешний id занят - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X PATCH "https://api.saleya.app/v1/customers/{customer}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"name": "string",
"language": "ru",
"external_id": "string"
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": "string",
"phone": "string",
"email": "string",
"language": "ru",
"is_blocked": true,
"marketing_consents": [
{
"channel": "email",
"status": "subscribed",
"consented_at": "2026-01-15T12:00:00Z"
}
],
"accepts_marketing": true,
"marketing_consent_at": "2026-01-15T12:00:00Z",
"balance": 0,
"addresses": [
{
"id": 0,
"customer_id": 0,
"label": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"postal_code": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"is_default": true,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"group_ids": [
0
],
"wholesale_price_list_id": 0,
"merged_into_customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Покупатель по внешнему id
get/customers/by-external-id/{external_id}
Scope: customers:read
Параметры
Путь
external_idstringобязательноВнешний id — id записи в вашей системе.
Ответы
200Успешно
Заголовки
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Customer
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/customers/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"external_id": "string",
"version": 0,
"name": "string",
"phone": "string",
"email": "string",
"language": "ru",
"is_blocked": true,
"marketing_consents": [
{
"channel": "email",
"status": "subscribed",
"consented_at": "2026-01-15T12:00:00Z"
}
],
"accepts_marketing": true,
"marketing_consent_at": "2026-01-15T12:00:00Z",
"balance": 0,
"addresses": [
{
"id": 0,
"customer_id": 0,
"label": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"postal_code": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"is_default": true,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"group_ids": [
0
],
"wholesale_price_list_id": 0,
"merged_into_customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Создать или изменить покупателя по внешнему id
patch/customers/by-external-id/{external_id}
Scope: customers:write
Параметры
Путь
external_idstringобязательноВнешний id — id записи в вашей системе.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringETag записи из последнего чтения. Обязателен, если запись с этим внешним id уже есть (иначе 428), и не передаётся, если её нет.
- Пример:
"7"
If-None-Matchstring* — только создать: если запись с этим внешним id уже есть, запрос получит 412.
- Значения:
*
Тело запроса application/json
namestringИмя покупателя; null, если неизвестно.
- Макс. длина:
- 120
- Шаблон:
\S
languagestringЯзык, на котором магазин пишет покупателю: ru, en или es.
- Значения:
ruenes
phonestringОсновной телефон покупателя в формате E.164, например +5491123456789; null, если неизвестен.
- Макс. длина:
- 32
emailstringEmail покупателя; null, если неизвестен.
- Макс. длина:
- 254
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Customer
201Создано
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
Locationstring (uri)обязательноАдрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.
application/json
Возвращает Customer
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
customer_contact_in_useКонтакт уже у покупателя магазина - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X PATCH "https://api.saleya.app/v1/customers/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"name": "string",
"language": "ru",
"phone": "string",
"email": "string"
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": "string",
"phone": "string",
"email": "string",
"language": "ru",
"is_blocked": true,
"marketing_consents": [
{
"channel": "email",
"status": "subscribed",
"consented_at": "2026-01-15T12:00:00Z"
}
],
"accepts_marketing": true,
"marketing_consent_at": "2026-01-15T12:00:00Z",
"balance": 0,
"addresses": [
{
"id": 0,
"customer_id": 0,
"label": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"postal_code": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"is_default": true,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"group_ids": [
0
],
"wholesale_price_list_id": 0,
"merged_into_customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Назначить покупателю оптовый прайс-лист или снять его
post/customers/{customer}/wholesale-price-list
Scope: customers:writeorders:wholesale
Параметры
Путь
customerintegerобязательноID покупателя.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringобязательноETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.
- Пример:
"7"
Тело запроса application/json
price_list_idinteger или nullобязательноОптовый прайс-лист покупателя; null снимает назначение — оптовые продажи покупателю идут по базовым ценам.
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Customer
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/customers/{customer}/wholesale-price-list" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"price_list_id": 0
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": "string",
"phone": "string",
"email": "string",
"language": "ru",
"is_blocked": true,
"marketing_consents": [
{
"channel": "email",
"status": "subscribed",
"consented_at": "2026-01-15T12:00:00Z"
}
],
"accepts_marketing": true,
"marketing_consent_at": "2026-01-15T12:00:00Z",
"balance": 0,
"addresses": [
{
"id": 0,
"customer_id": 0,
"label": "string",
"street": "string",
"house": "string",
"apartment": "string",
"floor": "string",
"entrance": "string",
"district": "string",
"postal_code": "string",
"comment": "string",
"location": {
"lat": 0,
"lng": 0
},
"is_default": true,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"group_ids": [
0
],
"wholesale_price_list_id": 0,
"merged_into_customer_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}