Формат данных о заказах и клиентах
Описанные ниже поля передавайте с помощью метода POST /cdp/api/v1/counter/{counterId}/data/simple_orders.
Обязательные колонки:
create_date_time
— дата и время создания заказа в часовом поясе счетчика. Дату создания нельзя изменить после отправки данных о заказе. Подробнее о формате даты и времени.id
— идентификатор заказа в вашей CRM. Передачаid
позволяет обновлять статусы заказа и перепривязывать заказ с одного клиента на другого. Еслиid
не передан, заказы атрибутируются к ближайшим к переданной дате создания заказа визитам и могут дублироваться.
Обязательна хотя бы одна из колонок:
client_ids
— список ClientID. Подробно см. в Подготовка данных для привязки к визитам.emails
— список адресов электронной почты клиента. Строка латиницей, включающая символ @ и имя домена. Нельзя использовать прописные буквы. Пример:mail@yandex.ru
.phones
— список телефонных номеров клиента. Числовая строка, содержащая номер мобильного телефона с указанием кода страны. Нельзя использовать пробелы и дополнительные символы. Пример:79995551111
.emails_md5
— список адресов электронной почты клиента, хешированных в формате md5. Для проверки алгоритма, которым вы пользуетесь для хеширования, вы можете использовать почтуmail@yandex.ru
. Хеш от нее должен получиться:3c56ff8fef0f6c65b36b2d25720fe276
.phones_md5
— список телефонных номеров клиента, хешированных в формате md5. Для проверки алгоритма, которым вы пользуетесь для хеширования, вы можете использовать номер телефона79995551111
. Хеш от него должен получиться:f09f2c3d48f31e2a802944ade2e5aec5
.
Примечание
Чтобы передавать один или несколько телефонных номеров или адресов электронной почты, оберните их в кавычки. При передаче нескольких значений разделите их запятой. Если вы передаете хеши от телефонов и почт, захешируйте каждый телефон/почту отдельно, оберните хеши от телефонов и почт в кавычки и разделите запятой без пробелов.
Пример: "79876543210,79991234567"
или "mail@example.com,mail2@example.com"
.
Необязательные колонки:
-
client_uniq_id
— идентификатор клиента в CRM, связанного с заказом. -
order_status
— тип статуса заказа. Произвольная строка. Статус можно менять.Возможные значения:
-
PAID
— оплачен (применяется по умолчанию если вы не передаете статусы заказов), при передаче будут достигнуты цели CRM: Заказ создан и CRM: Заказ оплачен; -
IN_PROGRESS
— в работе, при передаче будет достигнута цель CRM: Заказ создан; -
CANCELLED
— отменен, при передаче этого типа статуса не будут достигнуты цели; -
SPAM
— спам, аналогично отмененному заказу не будут достигнуты цели; -
Аналогично статусам выше вы можете отправить значение javascript-идентификатора ваших целей JavaScript-событие — в таком случае будет достигнута переданная цель.
Пример
Вы можете использовать цель JavaScript-событие Квалифицированнный лид с идентификатором
kval_lead
и присылать в качестве статуса заказа этот идентификатор для достижения в заказе соответствующей цели.
-
-
revenue
— доход. Суммарная стоимость заказа. Десятичная дробь. Передавайте выручку от заказа. Это значение будет использоваться в отчетах Сквозной аналитики, чтобы показать сколько денег принесли заказы с рекламных каналов. Значение будет показано в метрике «Выручка». -
cost
— себестоимость. Десятичная дробь. Вы можете передать себестоимость заказов, чтобы учитывать прибыль в отчетах Сквозной аналитики. Прибыль будет рассчитана по формуле:Выручка - Себестоимость
.Примечание
При указании себестоимости доход целей выполняемых в заказе будет указан как revenue-cost.
-
currency
— валюта заказа в виде трехбуквенного кода валюты по ISO 4217. Без указания параметра всегда выбраны рубли (RUB). -
goals
— дополнительные цели заказа. Помимо основной цели, которая выполняется при отправке соответствующегоorder_status
заказа (IN_PROGRESS
,PAID
, JavaScript-идентификаторы) и доход которой будет указан как revenue-cost, вы можете отправить дополнительные идентификаторы JavaScript-целей с возможностью передачи своего дохода.Пример
Поле goals заказа заполнено как "branch1:15000,oformlenie_analizov,oplata_cash:15000".
Используются три идентификатора JavaScript-целей счетчика:
Оплата в первом филиале —
branch1
— на сумму 15000 руб.Оформление анализов —
oformlenie_analizov
— без указания суммы. Для этой цели доход будет рассчитан по формуле: revenue-cost, если эти данные заполнены для заказа.Оплата наличными —
oplata_cash
— на сумму 15000 руб.