DELIVERYCRM WIKI - Вклад участника [ru]

Интеграция через API

2026-01-14T11:12:30Z

Rlab: /* Описание метода добавления треков */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.strekoza.su:4435/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.strekoza.su:4435/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.strekoza.su:4435/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.strekoza.su:4435/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.strekoza.su:4435/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:11:54Z

Rlab: /* Описание метода обновления данных заказа */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.strekoza.su:4435/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.strekoza.su:4435/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.strekoza.su:4435/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.strekoza.su:4435/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.strekoza.su:4435/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:11:41Z

Rlab: /* Описание метода получения финансовой информации пользователя */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.strekoza.su:4435/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.strekoza.su:4435/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.strekoza.su:4435/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.strekoza.su:4435/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:11:26Z

Rlab: /* Описание метода запроса информации по трекам */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.strekoza.su:4435/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.strekoza.su:4435/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.strekoza.su:4435/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:11:04Z

Rlab: /* Описание метода удаления треков */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.strekoza.su:4435/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.strekoza.su:4435/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:10:50Z

Rlab: /* Описание метода добавления треков */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.strekoza.su:4435/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.r-lab.biz/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:08:59Z

Rlab: Отмена правки 1060, сделанной Rlab (обсуждение)

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.r-lab.biz/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.r-lab.biz/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:08:20Z

Rlab: Отмена правки 1059, сделанной Rlab (обсуждение)

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.r-lab.biz/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.strekoza.su:4435
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:07:08Z

Rlab: /* Описание метода удаления треков */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.strekoza.su:4435 
Формат передачи данных: JSON 
Метод: POST 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.strekoza.su:4435
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2026-01-14T11:06:18Z

Rlab: /* Описание метода добавления треков */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.strekoza.su:4435 
Формат передачи данных: JSON 
Метод: POST 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":"",
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":"",
"trackingUserClientDeliveryServiceId":0,
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.r-lab.biz/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API V2

2023-10-11T09:56:09Z

Rlab: Новая страница: «Тест»

Тест

Интеграция через API

2023-10-02T13:06:43Z

Rlab:

От какого имени отправляются СМС и как его изменить?

2023-03-01T09:11:51Z

Rlab: Смена тарифов

По умолчанию рассылка ведется с нашего стандартного имени '''PostStatus''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 3.6₽

'''Стоимость СМС от имени вашей компании: 3.7₽
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2022-12-29T08:25:12Z

Rlab: Повышение 1 января

По умолчанию рассылка ведется с нашего стандартного имени '''PostStatus''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 3.5₽

'''Стоимость СМС от имени вашей компании: 3.6₽
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2022-11-30T08:00:34Z

Rlab:

По умолчанию рассылка ведется с нашего стандартного имени '''PostStatus''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 3.25₽

'''Стоимость СМС от имени вашей компании: 3.35₽
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2022-08-31T08:27:05Z

Rlab:

По умолчанию рассылка ведется с нашего стандартного имени '''PostStatus''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 3.15₽

'''Стоимость СМС от имени вашей компании: 3.30₽
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2022-05-31T12:13:14Z

Rlab:

По умолчанию рассылка ведется с нашего стандартного имени '''PostStatus''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 3.05₽

'''Стоимость СМС от имени вашей компании: 3.20₽
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2022-03-31T09:00:27Z

Rlab:

По умолчанию рассылка ведется с нашего стандартного имени '''PostStatus''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 2.90₽

'''Стоимость СМС от имени вашей компании: 3.10₽
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2022-01-31T09:50:21Z

Rlab: Смена тарифов

По умолчанию рассылка ведется с нашего стандартного имени '''DostavkInfo''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 2.60 руб.'''

'''Стоимость СМС от имени вашей компании: 2.80 руб.'''
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

Интеграция через API

2021-06-07T14:39:14Z

Rlab:

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.r-lab.biz/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
"trackingUserClientDeliveryServiceId":0
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|-
|trackingUserLR3CampaignId
|Integer
|ID цепочки информирования. используется для распределения трафика по разным цепочкам информирования.
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.r-lab.biz/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2021-03-10T13:42:03Z

Rlab: /* Метод для получения информации об уведомлениях и их статусах */

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.r-lab.biz/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
"trackingUserClientDeliveryServiceId":0
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.r-lab.biz/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Интеграция через API

2021-03-10T13:34:07Z

Rlab:

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.r-lab.biz/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
"trackingUserClientDeliveryServiceId":0
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.r-lab.biz/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

От какого имени отправляются СМС и как его изменить?

2021-02-27T07:37:44Z

Rlab:

По умолчанию рассылка ведется с нашего стандартного имени '''DostavkInfo''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 2.35 руб.'''

'''Стоимость СМС от имени вашей компании: 2.70 руб.'''
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2020-12-24T15:46:17Z

Rlab:

По умолчанию рассылка ведется с нашего стандартного имени '''DostavkInfo''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 2.15 руб.'''

'''Стоимость СМС от имени вашей компании: 2.40 руб.'''
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2020-11-30T11:45:29Z

Rlab:

По умолчанию рассылка ведется с нашего стандартного имени '''DostavkInfo''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 2.05 руб.'''

'''Стоимость СМС от имени вашей компании: 2.40 руб.'''
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@strekoza.ai'''

От какого имени отправляются СМС и как его изменить?

2020-11-30T11:45:07Z

Rlab:

По умолчанию рассылка ведется с нашего стандартного имени '''DostavkInfo''', но вы можете зарегистрировать свое, указав название своей организации и ИНН в разделе настроек магазина.

'''Стоимость СМС от общего имени: 2.05 руб.'''

'''Стоимость СМС от имени вашей компании: 2.40 руб.'''
----

'''Требования к имени:'''

- Имя должно содержать от 2 до 11 латинских символов (ограничение GSM протокола).
В качестве отправителя нельзя использовать одни цифры, имена, фамилии, номера телефона и торговые марки, на которые у вас нет разрешения. Все имена проходят обязательную проверку.

- Имя должно четко идентифицировать ваш
магазин

- Нельзя указывать имена, фамилии, номера
телефонов. Известные бренды можно
использовать только после дополнительного
согласования

- Нельзя использовать общие названия: почта,
письмо, посылка, заказ и подобные

- '''Требования МТС:'''

'''Абонентская плата за собственное имя отправителя в МТС'''

C 1 августа 2019 года МТС (Россия) меняет условия оказания услуг по рассылке СМС. За выделение и обслуживание собственного имени отправителя оператором будет взиматься ежемесячная плата в размере 2 000 руб.. Если вы отправляете СМС от общего имени, то для вас условия работы не меняются.

Все текущие зарегистрированные имена в МТС будут удалены, потребуется повторная регистрация.

Напишите нам в чат или на почту support@strekoza.ai для подачи заявки на перерегистрацию имени.

Регистрация имен на 1 августа будет производиться в два этапа: до 15 июля и до 23 июля. Абонентская плата будет списываться автоматически 1 числа каждого месяца.

Если вы не подадите заявку по новым правилам, мы будем отправлять СМС абонентам МТС от общего имени. Возможно, оператор введет более высокий тариф для тех, кто не оплатил ежемесячный платеж – данная информация уточняется.

Условия по регистрации имен остаются без изменений: Важно, чтобы имя отправителя совпадало с названием вашей компании, являлось зарегистрированным товарным знаком либо доменным именем, подтвержденным сертификатом. Оператор строго проверяет имена, и все несоответствующие их правилам отклоняет.

Если название вашей компании не совпадает с именем отправителя, то необходимо предоставить документ, подтверждающий право на использование имени.

Необходимые документы вы можете отправить на '''support@r-lab.biz'''

Модуль интеграции с RetailCRM

2020-10-21T06:34:51Z

Rlab:

Для того, чтобы подключить трекинг-сервис отследить-посылку.рф к Вашему магазину нужно произвести настройки интеграции модуля.

1. Перейдите в раздел "Администрирование", далее во вкладку "Ключ доступа к API" и добавьте новый ключ доступа для магазина, который Вы хотите подключить к сервису Strekoza.ai

[[Файл:re1.png]] 
 

2. Далее перейдите на страницу [https://deliverycrm.ru/retailcrm настройки интеграции] в сервисе отследить-посылку.рф и заполните поля настройки соответствующими данными.

3. Следующим шагом будет привязка магазинов

[[Файл:re2.png]] 
 

Готово. При добавлении трек-номера в поле "Номер отправления", добавленное интеграцией со службой доставки, или в пользовательское поле, он будет отслеживаться нашей системой и уведомлять покупателя о статусе посылки.

Заглавная страница

2020-10-21T06:08:01Z

Rlab:

Добро пожаловать в Strekoza wiki!

Информация, которая размещена на данном ресурсе, поможет Вам усвоить функционал сервиса, правильно настроить его и продуктивно использовать в дальнейшем.

----
Внимание! Продукт непрерывно совершенствуется, в этой связи возможны расхождения отдельных страниц ресурса и текущего состояния сервиса. Стараясь оперативно устранять несоответствия, мы призываем Вас не переставать следить за интересующими страницами.

- [[Знакомство с личным кабинетом]]

- [[От какого имени отправляются СМС и как его изменить?]]

- [[Умное информирование]]

- [[Скоринг]]

- [[Магазины, цепочки уведомлений и правила]]

- [[Гибкая настройка схемы уведомлений с помощью условий]]

- [[Добавление заказов]]

- [[Отзывы]]

- [[Автоплатежи]]

- [[Интеграции]]

- [[Telegram Bot]]

Telegram Bot

2020-10-21T06:07:21Z

Rlab:

Strekoza Bot – лучший способ быстро получить главную информацию с вашего аккаунта.

'''Как начать пользоваться?'''

Чтобы пользоваться ботом необходимо приложение “Telegram” для вашего устройства.
В поиске телеграма введите ID бота “@OPmonitorbot”.

[[Файл:accbot1.1.jpg|750px]]

Для того чтобы добавить аккаунт, информацию которого вы хотите получить, (1) напишите команду “/help” в чат с ботом и (2) нажмите “Добавить аккаунт”.

[[Файл:accbot3.jpg|500px]]

Дальше вам необходимо будет ввести ID вашего аккаунта в сервисе. Чтобы найти его, перейдите в раздел доступ в ЛК

[[Файл:Tgbot1.jpg|500px]]

На этой странице вы найдете и ID и API ключ.

[[Файл:Tgbot2.jpg|500px]]

Таким образом вы будете подключены к нашему боту. Каждый день в 10 утра вам будет приходить отчет о балансе, загруженных треках и выкупе. Вы также в любой момент можете: посмотреть подключенные аккаунты, количество загруженных треков, выкуп и баланс, пополнить баланс и удалить аккаунт из бота.

[[Файл:accbot7.jpg]]

Файл:Tgbot2.jpg

2020-10-21T06:06:51Z

Rlab:

Файл:Tgbot1.jpg

2020-10-21T06:04:00Z

Rlab:

Автоплатежи

2020-10-21T06:01:26Z

Rlab: /* Подключение */

=Автоматического пополнения счета=
Появилась возможность автоматического пополнения счета с вашей банковской карты.

=Подключение=

Для подключения этой услуги необходимо:

Перейти в раздел Баланс=>Автоплатежи

[[Файл:AutoPay1.jpg|500px]] 
 

Ознакомиться с условиями оказания услуги, подтвердить согласие с ними, нажав соответствующую кнопку «Подтверждаю». И затем нажать кнопку «Подключить»

[[Файл:AutoPay2.jpg|500px]] 
 

После этого необходимо указать:

Значение баланса, при достижении которого будет осуществляться автоматическое пополнение.

Сумму автоматического пополнения (Минимальная сумма для автоматического пополнения — 500р)

Сумму платежа для подключение автоматических платежей

[[Файл:AutoPay3.jpg|500px]] 
 

После этого происходит переход на сайт Робокассы для осуществления платежа

[[Файл:ap4.png]] 
 

Вводим данные банковской карты и осуществляем платеж.

Происходит переадресация обратно в личный кабинет

[[Файл:ap5.png]] 
 
Теперь автоматическое пополнение подключено.

=Отключение=

Для его отключения необходимо просто перевести ползунок в положение выключено (1)

[[Файл:ap6.png]] 
 
На экран выводится уведомление, что автоматические платежи отключены.

[[Файл:ap7.png]]

Файл:AutoPay3.jpg

2020-10-21T05:47:47Z

Rlab:

Заглавная страница

2020-10-19T15:11:26Z

Rlab:

Интеграция otpravka.pochta.ru

2020-10-19T14:24:01Z

Rlab:

Для того чтобы сократить рутинную деятельность менеджеров и полностью автоматизировать передачу трек-номеров нужно осуществить интеграцию сервиса Отследить-посылку.рф и вашего аккаунта в сервисе otpravka.pochta.ru. Это не займет больше двух минут, но сэкономит уйму времени и исключит ошибки при передаче трекномеров менеджерами.

Для интеграции с Отследить-посылку.рф и API Онлайн-сервиса «Отправка» необходимо располагать:

1. Токеном авторизации приложения.
После активации доступа к API токен высылается на электронную почту, указанную при регистрации на онлайн-сервисе «Отправка» (otpravka.pochta.ru).
Также токен можно узнать в настройках личного кабинета Онлайн-сервиса «Отправка»[https://otpravka.pochta.ru/settings#/api-settings]

2. Ключом авторизации пользователя.
Ключ авторизации пользователя генерируется с помощью алгоритма base64. Сгенерировать ключ можно на сайте Почты России [https://otpravka.pochta.ru/specification#/authorization-key].

Переходим к самой интеграции:

Перейдите в раздел добавления треков и выберите пункт "Интеграции". Вы попали на страницу доступных интеграций. Среди всех нам нужна Почта России Отправка.

[[Файл:33333.jpg|1000px]] 

Теперь все что осталось - это вести токен [1] и ключ [2] в соответствующие поля, нажать сохранить и не забыть включить интеграцию передвинув переключатель в зеленое положение.

[[Файл:1111.jpg|750px]] 

Готово. Теперь Вам не нужно возиться с таблицами, выгрузками из CRM и прочим. Мы автоматически получаем информацию об отправленных вами партиях посылок.

Вы можете подключить дополнительные кабинеты otpravka.pochta.ru в нашем сервисе. Для этого необходимо создать дополнительные магазины. Для каждого магазина в нашем сервисе можно подключить один кабинет otpravka.pochta.ru.

Интеграция otpravka.pochta.ru

2020-10-19T14:23:33Z

Rlab:

Для того чтобы сократить рутинную деятельность менеджеров и полностью автоматизировать передачу трек-номеров нужно осуществить интеграцию сервиса Отследить-посылку.рф и вашего аккаунта в сервисе otpravka.pochta.ru. Это не займет больше двух минут, но сэкономит уйму времени и исключит ошибки при передаче трекномеров менеджерами.

Для интеграции с Отследить-посылку.рф и API Онлайн-сервиса «Отправка» необходимо располагать:

1. Токеном авторизации приложения.
После активации доступа к API токен высылается на электронную почту, указанную при регистрации на онлайн-сервисе «Отправка» (otpravka.pochta.ru).
Также токен можно узнать в настройках личного кабинета Онлайн-сервиса «Отправка»[https://otpravka.pochta.ru/settings#/api-settings]

2. Ключом авторизации пользователя.
Ключ авторизации пользователя генерируется с помощью алгоритма base64. Сгенерировать ключ можно на сайте Почты России [https://otpravka.pochta.ru/specification#/authorization-key].

Переходим к самой интеграции:

Перейдите в раздел добавления треков и выберите пункт "Интеграции". Вы попали на страницу доступных интеграций. Среди всех нам нужна Почта России Отправка.

[[Файл:33333.jpg|1000px]] 

Теперь все что осталось - это вести токен [1] и ключ [2] в соответствующие поля, нажать сохранить и не забыть включить интеграцию передвинув переключатель в зеленое положение.

[[Файл:1111.jpg|1000px]] 

Готово. Теперь Вам не нужно возиться с таблицами, выгрузками из CRM и прочим. Мы автоматически получаем информацию об отправленных вами партиях посылок.

Вы можете подключить дополнительные кабинеты otpravka.pochta.ru в нашем сервисе. Для этого необходимо создать дополнительные магазины. Для каждого магазина в нашем сервисе можно подключить один кабинет otpravka.pochta.ru.

Интеграция otpravka.pochta.ru

2020-10-19T14:23:15Z

Rlab:

Для того чтобы сократить рутинную деятельность менеджеров и полностью автоматизировать передачу трек-номеров нужно осуществить интеграцию сервиса Отследить-посылку.рф и вашего аккаунта в сервисе otpravka.pochta.ru. Это не займет больше двух минут, но сэкономит уйму времени и исключит ошибки при передаче трекномеров менеджерами.

Для интеграции с Отследить-посылку.рф и API Онлайн-сервиса «Отправка» необходимо располагать:

1. Токеном авторизации приложения.
После активации доступа к API токен высылается на электронную почту, указанную при регистрации на онлайн-сервисе «Отправка» (otpravka.pochta.ru).
Также токен можно узнать в настройках личного кабинета Онлайн-сервиса «Отправка»[https://otpravka.pochta.ru/settings#/api-settings]

2. Ключом авторизации пользователя.
Ключ авторизации пользователя генерируется с помощью алгоритма base64. Сгенерировать ключ можно на сайте Почты России [https://otpravka.pochta.ru/specification#/authorization-key].

Переходим к самой интеграции:

Перейдите в раздел добавления треков и выберите пункт "Интеграции". Вы попали на страницу доступных интеграций. Среди всех нам нужна Почта России Отправка.

[[Файл:33333.jpg|1000px]] 

Теперь все что осталось - это вести токен [1] и ключ [2] в соответствующие поля, нажать сохранить и не забыть включить интеграцию передвинув переключатель в зеленое положение.

[[Файл:1111.jpg|1000px] 

Готово. Теперь Вам не нужно возиться с таблицами, выгрузками из CRM и прочим. Мы автоматически получаем информацию об отправленных вами партиях посылок.

Вы можете подключить дополнительные кабинеты otpravka.pochta.ru в нашем сервисе. Для этого необходимо создать дополнительные магазины. Для каждого магазина в нашем сервисе можно подключить один кабинет otpravka.pochta.ru.

Файл:1111.jpg

2020-10-19T14:22:57Z

Rlab:

Файл:33333.jpg

2020-10-19T14:22:22Z

Rlab:

Магазины, цепочки уведомлений и правила

2020-10-19T14:21:17Z

Rlab: /* Магазины */

'''Магазины''', '''Цепочки уведомлений ''' и '''Правила'''. Что это и зачем они нужны?

Для максимально тонкой настройки в сервисе Стрекоза Вы можете создавать различные, отдельные правила информирования по каждому статусу каждой службы доставки. Для удобства и порядка, мы разделили все это на три уровня - Магазины, цепочки уведомлений и правила.

=Магазины=

Многие из Вас ведут не один интернет-магазин, а несколько - тизерные, партнерские, CPA сети, лендинги - Когда трафик поступает из множества источников, и клиентам отправляются разные категории товаров, удобно разделять их обработку, в том числе по информированию.

Кому то вы продаете офферы со средним чеком 1000-2000 рублей, а кому то серьезные заказы с крупными чеками. Соответственно, все ведение и сопровождение заказов по разным категориям клиентов должно строится по разному.

Итак, для примера представим компанию X, которая ведет 4 ресурса - 2 интернет-магазина одежды, и 2 лендинга с различной косметикой.

В Стрекозе понадобится только один аккаунт, в рамках которого можно создать 4 "магазина":

[[Файл:2222.jpg|1000px]]

Для каждого магазина можно отдельно настроить основную информацию, которую затем можно будет подставлять в текст уведомлений:

[[Файл:Shop setup 1.jpg|500px]]



Кроме того для каждого магазина можно указать реквизиты, общие настройки отправки уведомлений.

[[Файл:Shop setup 2.jpg|500px]]

А так же выбрать нужные типы уведомлений и подключить службы доставки:

[[Файл:Shop setup 3.jpg|500px]]

=Цепочки уведомлений=
Цепочка уведомлений представляет собой свод "правил" информирования, к настройке можно перейти из раздела "Настройки уведомлений". В одной цепочке можно собрать все правила по одной службе доставки, или все правила, касающиеся отслеживания статусов посылок.

1 - Сводная информация о количестве активных уведомлений 
2 - Переход к просмотру всех текстов уведомлений на одной странице 
3 - Переход к списку посылок, которые будут и были обработаны данной цепочкой 
4 - Правила цепочки, расположенные в хронологическом порядке срабатывания 
5 - Кнопка добавления правила 
6 - Отключение цепочки, перенос ее в другой магазин и переименование 
7 - Кнопки добавления нового правила, и копирования правила из другой цепочки 
8 - Перечень настроенных правил. Здесь можно отдельно отключать разные уведомления и целые правила. 

[[Файл:44444.jpg|1000px]]

=Правила=

Правило представляет из себя задание для системы - что и как доносить до клиента при наступлении того или иного статуса посылки.

На странице редактирования правила расположены следующие разделы: 
1 - Название правила, навигация между правилами цепочки 
2 - Блок основных параметров правила - здесь настраивается повод для уведомления, служба доставки, временные ограничения 
3 - Блок редактирования текстов. Переходя по вкладкам можно отредактировать тексты всех уведомления правила, проверить предпросмотр (или прослушать звонок) 
4 - Блок условий - здесь можно настроить особые условия для срабатывания этого правила (подробнее в [[Гибкая настройка схемы уведомлений с помощью условий|данной статье]].). 
5 - Кнопка сохранения правил - сохраняет изменения во всех блоках. 
6 - Блок для настройки уведомлений менеджеру. 
7 - Блок настройки периодических напоминаний - важнейший блок для напоминаний забрать посылку. 
[[Файл:Rule edit.png|1000px]]

Файл:2222.jpg

2020-10-19T14:20:50Z

Rlab:

Магазины, цепочки уведомлений и правила

2020-10-19T14:19:58Z

Rlab: /* Цепочки уведомлений */

'''Магазины''', '''Цепочки уведомлений ''' и '''Правила'''. Что это и зачем они нужны?

Для максимально тонкой настройки в сервисе Стрекоза Вы можете создавать различные, отдельные правила информирования по каждому статусу каждой службы доставки. Для удобства и порядка, мы разделили все это на три уровня - Магазины, цепочки уведомлений и правила.

=Магазины=

Многие из Вас ведут не один интернет-магазин, а несколько - тизерные, партнерские, CPA сети, лендинги - Когда трафик поступает из множества источников, и клиентам отправляются разные категории товаров, удобно разделять их обработку, в том числе по информированию.

Кому то вы продаете офферы со средним чеком 1000-2000 рублей, а кому то серьезные заказы с крупными чеками. Соответственно, все ведение и сопровождение заказов по разным категориям клиентов должно строится по разному.

Итак, для примера представим компанию X, которая ведет 4 ресурса - 2 интернет-магазина одежды, и 2 лендинга с различной косметикой.

В Стрекозе понадобится только один аккаунт, в рамках которого можно создать 4 "магазина":

[[Файл:м1.jpg]]

Для каждого магазина можно отдельно настроить основную информацию, которую затем можно будет подставлять в текст уведомлений:

[[Файл:Shop setup 1.jpg|500px]]



Кроме того для каждого магазина можно указать реквизиты, общие настройки отправки уведомлений.

[[Файл:Shop setup 2.jpg|500px]]

А так же выбрать нужные типы уведомлений и подключить службы доставки:

[[Файл:Shop setup 3.jpg|500px]]

=Цепочки уведомлений=
Цепочка уведомлений представляет собой свод "правил" информирования, к настройке можно перейти из раздела "Настройки уведомлений". В одной цепочке можно собрать все правила по одной службе доставки, или все правила, касающиеся отслеживания статусов посылок.

1 - Сводная информация о количестве активных уведомлений 
2 - Переход к просмотру всех текстов уведомлений на одной странице 
3 - Переход к списку посылок, которые будут и были обработаны данной цепочкой 
4 - Правила цепочки, расположенные в хронологическом порядке срабатывания 
5 - Кнопка добавления правила 
6 - Отключение цепочки, перенос ее в другой магазин и переименование 
7 - Кнопки добавления нового правила, и копирования правила из другой цепочки 
8 - Перечень настроенных правил. Здесь можно отдельно отключать разные уведомления и целые правила. 

[[Файл:44444.jpg|1000px]]

=Правила=

Правило представляет из себя задание для системы - что и как доносить до клиента при наступлении того или иного статуса посылки.

На странице редактирования правила расположены следующие разделы: 
1 - Название правила, навигация между правилами цепочки 
2 - Блок основных параметров правила - здесь настраивается повод для уведомления, служба доставки, временные ограничения 
3 - Блок редактирования текстов. Переходя по вкладкам можно отредактировать тексты всех уведомления правила, проверить предпросмотр (или прослушать звонок) 
4 - Блок условий - здесь можно настроить особые условия для срабатывания этого правила (подробнее в [[Гибкая настройка схемы уведомлений с помощью условий|данной статье]].). 
5 - Кнопка сохранения правил - сохраняет изменения во всех блоках. 
6 - Блок для настройки уведомлений менеджеру. 
7 - Блок настройки периодических напоминаний - важнейший блок для напоминаний забрать посылку. 
[[Файл:Rule edit.png|1000px]]

Файл:44444.jpg

2020-10-19T14:15:11Z

Rlab:

Интеграция через API

2020-10-19T10:55:35Z

Rlab:

Документация по взаимодействию с сервисом через API
__TOC__

=Описание метода добавления треков=
URL: https://apilr2.r-lab.biz/addtrack.ashx 
Формат передачи данных: JSON 
Метод: POST 
Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru 
В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку. 

Пример контейнера с данными запроса:
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
"trackingUserPaymentType":"0"
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
"trackingUserClientDeliveryServiceId":0
"trackingUserPaymentType":"0"
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|нет
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная длина 40 символов)
|нет
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|-
|trackingUserPaymentType
|Integer
|Тип оплаты заказа - Предоплата/постоплата. С использованием данного параметра, можно разделять треки по типу оплаты, для разных схем информирования
|да (может быть нулем)
|}
{| class="wikitable"
|+Список значений trackingUserClientDeliveryServiceId (жирным выделены службы, поддерживаемые в настоящее время)
|-
|'''Почта России'''
|0
|-
|'''TopDelivery'''
|1
|-
|'''СПСР'''
|2
|-
|'''Boxberry'''
|3
|-
|'''PickPoint'''
|4
|-
|'''Shop-Logistics'''
|5
|-
|Деловые линии
|6
|-
|'''СДЭК'''
|7
|-
|'''DPD'''
|8
|-
|Экспресс.Ру
|9
|-
|ПЭК
|10
|-
|КСЭ
|11
|-
|Dimex
|12
|-
|УкрПочта
|13
|-
|'''Почта Казахстана'''
|15
|-
|Нова Пошта
|16
|}

{| class="wikitable"
|+Список значений trackingUserPaymentType (варианты типа оплаты)
|-
|'''Наложенный платеж'''
|1
|'''Предоплата'''
|2
|}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":"Данные успешно добавлены в базу","resultData":null} 
{"resultState":1," resultInfo ":"Часть данных добавлены в базу, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные успешно добавлены.
1 - данные частично добавлены (причина описана в resultInfo).
2 - ошибка, данные не добавлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Описание метода удаления треков=

Метод: удаление треков из системы, максимум 100 треков в одном запроса. Используется в случае, если по треку приходят некорректные смс. Удаленные треки считаются оплаченными.

URL: https://apilr2.r-lab.biz/deltrack.ashx
 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{ 
"trackingUserId":1, 
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a", 
"testMode":false, 
"trackingData":[{ 
"trackingUserClientPhone":"", 
"trackingUserClientTrack":"19527937484546", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
}, 
{"trackingUserClientPhone":"", 
"trackingUserClientTrack":"63010828068631", 
"trackingUserClientEmail":"", 
"trackingUserClientName":"", 
"trackingUserClientItemCost":0, 
"sendToUserEmailFullTracking":false, 
"sendToAdminEmailFullTracking":false 
""trackingUserClientDeliveryServiceId":0 
}] 
} 
'''В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.'''

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:''' 
{"resultState":0,"resultInfo":"Треки успешно удалены из базы","resultData":null} 
{"resultState":1," resultInfo ":"Часть треков удалены, ошибок 1","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 –треки удалены из системы
1 – запрос выполнен частично, см. resultInfo.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информациz по запрошенным трекам)
|}

=Описание метода запроса информации по трекам=
Метод: получение информации по трекинг-кодам (которые загружены в системе), максимум 100 треков в одном запроса.
URL: https://apilr2.r-lab.biz/gettrackinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
},
{"trackingUserClientPhone":"",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"",
"trackingUserClientName":"",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false
}]
}
В данном методе, в контейнере должно быть заполнено только одно свойство trackingUserClientTrack, остальные поля можно оставить пустыми.

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|В данном методе да
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут)
|да
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|да
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|да (может быть нулем)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientDeliveryServiceId
|Integer
|ID службы доставки. Данный параметр определяет, к какой службе доставки отнести трек.
|нет
|}

'''Примеры ответов от сервера:'''

{
"resultState": 0,
"resultInfo": "Запрос выполнен",
"resultData": [
{
"trackNumber": "19191911187312",
"trackInfo": "Приём отправления почтовым отделением",
"trackMainStatus": 9,
"trackCreateDate": "08.06.2018 14:22:55",
"trackUpdateDate": "19.07.2018 03:33:53",
"trackEventDate": "08.06.2018 18:45:57",
"trackRecepDate": "08.06.2018 18:45:57",
"trackExtraData": null,
"trackAdditionalStatus": 0,
"trackingUserClientPhone": "79000000000",
"trackingUserClientEmail": "mikspark@yandex.ru",
"trackingUserClientName": "",
"trackingUserClientItemCost": 0,
"trackingUserClientOrderNumber": "",
"trackingWaitIndex": 0,
"trackingDestinationIndex": 0,
"trackingCurrentIndex": 0,
"trackingWaitAddress": null,
"trackingHistory": null,
"trackingMailType": 0,
"trackingUserFullClientName": null,
"trackingWaitDate": null
}
]
}
 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Массив с данными (информация по запрошенным трекам)
|-
|trackCreateDate
|string
|Дата и время добавления трека в систему, формат dd.MM.yyyy HH:mm:ss
|-
|trackUpdateDate
|string
|Дата и время обновления статуса или информации по треку, формат dd.MM.yyyy HH:mm:ss. В случае если трек еще не обновлялся вернется значение null
|}
 
'''Варианты значения в свойстве trackMainStatus (основной статус):''' 
0 – отсутствует основной статус 
1 - вручено 
2 – ожидает в месте вручения 
3 - возврат 
4 – прием почтовым отделением (посылка в пути) 
5 – экспорт в Россию 
6 – импорт в Россию 
7 – прием почтового отправления за пределами России 
8 – посылка возможно в месте вручения (с момента последней сортировки прошло более 2х недель, или количество дней установленное в настройках) 
9 – просрочено (отсутствуют статусы «Вручение» или «Истек срок хранения» более 35 дней, либо более 60 дней не обновляются статусы «Прием», «Сортировка»,больше 60 дней статусы отсутствуют). 

=Описание метода получения финансовой информации пользователя=
 
URL: https://apilr2.r-lab.biz/getuserinfo.ashx 
Формат передачи данных: JSON 
Метод: POST 
Пример контейнера с данными запроса: 
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":null
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integrer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :ключ пользователя). Пример: 1:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|}

'''Примеры ответов от сервера:'''
{
"resultState":0,
"resultInfo":"Запрос выполнен",
"resultData": {
"userExpireDate":"Бессрочный",
"userBalance":60,
"userExpired":false,
"userBalanceUnlimited":false,
"userDateUnlimited":true
}
}
 или
{ "resultState":0, "resultInfo":"Запрос выполнен", "resultData":{ "userExpireDate":"13.04.2015", "userBalance":384, "userExpired":false, "userBalanceUnlimited":false, "userDateUnlimited":false } }

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 – запрос выполнен, см. resultData.
2 – ошибка в запросе (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация.
|-
|resultData
|JSON object
|Финансовая информация пользователя
|-
|userExpireDate
|string
|Дата окончания тарифа. Если тариф бессрочный, вместо даты будет возвращаться "Бессрочный".
|-
|userBalance
|integer
|Текущий баланс треков. Если баланс неограниченный, то будет возвращаться 1.
|-
|userExpired
|boolean
|false – тариф не просрочен
true – тариф просрочен
|-
|userBalanceUnlimited
|boolean
|false – баланс не неограниченный
true – баланс неограниченный
|-
|userDateUnlimited
|boolean
|false – тариф не бессрочный
true – тариф бессрочный
|}

=Описание метода обновления данных заказа=

URL: https://apilr2.r-lab.biz/updatetrack.ashx 
Формат передачи данных: JSON 
Метод: POST 

'''Пример контейнера с данными запроса:'''
{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"79160000000",
"trackingUserClientTrack":"19527937484546",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Дмитрий",
"trackingUserClientItemCost":123.45,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4321",
"trackingUserClientDescription":""
},
{"trackingUserClientPhone":"79150000000",
"trackingUserClientTrack":"63010828068631",
"trackingUserClientEmail":"support@r-lab.biz",
"trackingUserClientName":"Василий",
"trackingUserClientItemCost":623.12,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":"4331",
"trackingUserClientDescription":""
}]
}

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|'''Значение может быть пустым'''
|-
|trackingUserId
|integer
|id пользователя
|нет
|-
|trackingRequestKey
|string
|md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d
|нет
|-
|testMode
|boolean
|В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса
|нет
|-
|trackingData
|JSON array
|Содержит массив с трекинг номерами и данными клиента
|нет
|-
|trackingUserClientPhone
|string
|Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientTrack
|string
|Трекинг номер почтового отправления
|нет
|-
|trackingUserClientEmail
|string
|E-Mail клиента (если значение пустое, оповещения на E-Mail отправляться не будут)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientName
|string
|Имя или ФИО клиента
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientItemCost
|decimal
|Стоимость товаров
|Да (если значение = 0, то данные в базе не изменяться)
|-
|sendToAdminEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail администратора магазина (указанный при регистрации в https://strekoza.ai) будет отправлять письмо с информацией о статусе.
|нет
|-
|sendToUserEmailFullTracking
|boolean
|Если значение свойства true, то при каждом изменении статуса почтового отправления на E-Mail клиента магазина будет отправляться так же письмо с информацией о статусе.
|нет
|-
|trackingUserClientOrderNumber
|string
|Номер заказа (максимальная дли 40 символов)
|Да (если значение пустое, данные в базе не изменяться)
|-
|trackingUserClientDescription
|string
|Любые другие данные, например название товара или название магазина (если через один аккаунт отправляются оповещения от разных магазинов). Максимальная длина 200 символов.
|Да (если значение пустое, данные в базе не изменяться)
|}

<ins style="color: red">'''Внимание! Если нужно изменить только одно (или несколько) значений в базе, то не нужные свойства контейнера можно оставить пустыми. Например, если у трека нужно только изменить имя клиента, запрос будет выглядеть так:'''</ins> 

{
"trackingUserId":1,
"trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
"testMode":false,
"trackingData":[{
"trackingUserClientPhone":"",
"trackingUserClientTrack":"19527937484546"
"trackingUserClientEmail":""
"trackingUserClientName":"Николай",
"trackingUserClientItemCost":0,
"sendToUserEmailFullTracking":false,
"sendToAdminEmailFullTracking":false,
"trackingUserClientOrderNumber":""
}]
}

'''Примеры ответов от сервера:'''

{"resultState":0,"resultInfo":" Данные успешно добавлены в очередь на обновление","resultData":null} 
{"resultState":1," resultInfo ":" Часть данных обновлена в базе, ошибок 2","resultData":null} 
{"resultState":2," resultInfo ":"Некорректный ключ запроса в trackingRequestKey","resultData":null} 

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|resultState
|interger
|Код результата операции.
0 - данные добавлены в очередь на обновление.
1 - данные частично обновлены (причина описана в resultInfo).
2 - ошибка, данные не обновлены (причина описана в resultInfo).
|-
|resultInfo
|string
|В этом свойстве возвращается описание ошибки или общая информация
|-
|resultData
|JSON array
|Может содержать массив с данными (например, информацию по запрошенным трекам)
|}

=Черный список=

URL: https://api.deliverycrm.ru/v1/black/check 
Формат ответа: JSON 
Метод: GET 
Запрос статистики выкупов и невыкупов

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

https://api.deliverycrm.ru/v1/black/check?user_id=7847&request_key=bccb7d5ba3290d7ac8b5f14b1ced12d93e2c0c50&phone=79001234567

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по
двум входным значениям, дубликаты из результата поиска будут удалены.

'''Примеры ответов от сервиса:'''

[{"blackPhone":"79000000000","blackEmail":"","blackKarma":9.0,"blackComment":"возвратов 9, неизвестно 0, вручено 60","blackCancelCount":9,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":"","blackEmail":"test2@test.ru","blackKarma":0.0,"blackComment":"не найден о записей","blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

[{"blackPhone":null,"blackEmail":null,"blackKarma":-2.0,"blackComment":"Ошибка: Введите телефон или e-mail" ,"blackCancelCount":0,"blackExpiredCount":0,"blackDoneCount":60,"history":null}]

{| class="wikitable"
|+Описание свойств контейнера запроса:
|-
|'''Свойство'''
|'''Тип'''
|'''Описание'''
|-
|user_id
|integer
|Id пользователя
|-
|request_key
|string
|Sha1 hash запроса (id пользователя:ключ пользователя:телефон:email)
|-
|phone
|string
|Входящий параметр с номером телефона для поиска
|-
|email
|string
|Входящий параметр с e-mail адресом для поиска
|-
|blackKarma
|decimal
|Общее количество найденных записей либо код ошибки (в|будущих версиях сервиса будет возвращаться рассчитанный коэффициент доверия к покупателю). Возможные коды ошибок: -1 – ничего не найдено -2 – введите телефон или e-mail -3 – произошла ошибка за сервере (повторить запрос позже)
|-
|blackComment
|string
|Комментарий
|-
|blackCancelCount
|Integer
|Количество найденных заказов, которые по нашим данным, не забрал покупатель
|-
|blackExpiredCount
|integer
|Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
|-
|blackDoneCount
|integer
|Количество выкупов (прошедших через сервис https://strekoza.ai).
|-
|}

'''Метод для получения истории заказов прошедших через ОП'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo

'''Примеры:'''

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=&blackEmail=test@test.ru

https://black.r-lab.biz/api/BlackList/GetWhiteBlackHistoryInfo?blackPhone=79000000000&blackEmail=test@test.ru

В запросе можно одновременно передавать телефон и e-mail, в этом случае поиск будет осуществляться по двум входным значениям, дубликаты из результата поиска будут удалены.

'''Пример ответа'''

[
{
"blackPhone":"79000000000",
"blackEmail":"",
"blackKarma":6.0,
"blackComment":"возвратов 1, неизвестно 5",
"blackCancelCount":1,
"blackExpiredCount":5,
"blackDoneCount":0,
"blackTotalShopOrderCost":95520
"history":[
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-09T07:49:59",
"bwType":2,
"bwShopCategoryId":9,
"bwShopOrderCost":1452,
},
{
"bwEventDate":"2015-08-21T03:14:20",
"bwType":3,
"bwShopCategoryId":19,
"bwShopOrderCost":1220,
},
{
"bwEventDate":"2015-12-26T06:12:45",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2015-10-03T03:05:47",
"bwType":3,
"bwShopCategoryId":23,
"bwShopOrderCost":0,
},
{
"bwEventDate":"2017-09-20T07:00:27",
"bwType":3,
"bwShopCategoryId":9,
"bwShopOrderCost":2410,
}
]
}
]

*blackCancelCount - Количество найденных заказов, которые по нашим данным, не забрал покупатель
*blackExpiredCount - Количество найденных заказов, которые по нашим данным, возможно, не забрал покупатель. Например, после 35-40 дней с момента прибытия статус посылки не меняется на «Вручение» или «Возврат», т.е. судьба заказа неизвестна, в большинстве случаев это «Возврат».
*blackDoneCount - Количество найденных заказов, которые забрал покупатель (заказы только прошедшие через наш сервис)
*bwEventDate - Дата события (вручение, возврат или когда статус трека перешел в финальное состояние)
*bwType - возможные значения:

1 - вручение
2 - возврат
3 - просрочено (неизвестно)

bwShopCategoryId - категория магазина где был сделан заказ, возможные значения:

1 - Авто (запчасти,аксессуары и т.д.)
2 - Товары для животных
3 - Бытовая техника
4 - Дом и дача
5 - Досуг и развлечения
6 - Интим-товары
7 - Компьютеры
8 - Оборудование
9 - Одежда, обувь и аксессуары
10 - Подарки и цветы
11 - Продукты
12 - Спорт и отдых
13 - Товары для здоровья
14 - Услуги
15 - Электроника
16 - Книги и журналы
17 - CPA
18 - Табачные изделия,электронные сигареты и т.д.
19 - Парфюмерия и косметика
20 - TV-Shop
21 - Товары для детей
22 - Универсальный (торгуем всем)
23 - Другое
24 - Ювелирные украшения и т.д.

=Примеры кода=

/**
* Class RlabTrack
*/
class RlabTrack
{
/**
* @var
*/
protected $user_id;
/**
* @var
*/
protected $api_key;
/**
* @var bool
*/
protected $test_mode;
/**
* @var array
*/
protected $tracks = array();
/**
* @var array
*/
protected $track_ids = array();
/**
* RlabTrack constructor.
* @param $user_id
* @param $api_key
* @param bool $testMode
*/
public function __construct($user_id, $api_key, $testMode = false)
{
$this->user_id = $user_id;
$this->api_key = $api_key;
$this->test_mode = $testMode;
}
/**
* @param $telephone
* @param $track
* @param $email
* @param $name
* @param int $itemCost
* @param string $order_number
* @param bool $userFullTracking
* @param bool $adminFullTracking
*/
public function addTrack($telephone, $track, $email, $name, $itemCost = 0, $order_number = '', $userFullTracking = false, $adminFullTracking = false)
{
$this->track_ids[] = $track;
$this->tracks[] = array(
"trackingUserClientPhone" => strval(preg_replace("/[^\d]/isu", '', $telephone)),
"trackingUserClientTrack" => strval($track),
"trackingUserClientEmail" => strval($email),
"trackingUserClientName" => strval($name),
"trackingUserClientItemCost" => (int)$itemCost,
"trackingUserClientOrderNumer" => strval($order_number),
"sendToUserEmailFullTracking" => (bool)$userFullTracking,
"sendToAdminEmailFullTracking" => (bool)$adminFullTracking,
);
}
/**
* @return mixed
*/
public function send()
{
$postfields = array(
"trackingUserId" => $this->user_id,
"trackingRequestKey" => md5($this->user_id . ':' . implode('', $this->track_ids) . ':' . $this->api_key),
"testMode" => $this->test_mode,
"trackingData" => $this->tracks,
);
$curl = curl_init('http://apilr2.r-lab.biz/addtrack.ashx');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/plain; charset=utf-8",
));
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($postfields, JSON_UNESCAPED_UNICODE));
$result = curl_exec($curl);
curl_close($curl);
return @json_decode($result);
}
/**
*
*/
public function clear()
{
$this->tracks = array();
}
}

=Метод для получения информации об уведомлениях и их статусах=

URL: https://api.deliverycrm.ru/v1/track/history
Метод: GET

Параметры:
*user_id - ID пользователя (аккаунта). Можно посмотреть https://deliverycrm.ru/client/profile/index в профиле
*request_key - ключ запроса, формируется как sha1(user_id + все номера треков без разделителей + API ключ). Ключ API можно узнать https://deliverycrm.ru/client/profile/index в профиле.

Пример формирования ключа запроса. Если user_id = 999999, а API ключ = 07dbd136d760e6be8fde6a2238992831, и вы хотите узнать информацию по двум трекам 18112831338669 и BZXH10758710, то ключ получаем следующим образом:

sha1(999999 + 18112831338669 + BZXH10758710 + 07dbd136d760e6be8fde6a2238992831) = b3c6236d57025ee7d37584059685b08cece8f3f9

*tracks - номера почтовых отправлений (треки).

Массив вида

<pre>
'tracks' => [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта России)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
]</pre>

service_id не обязательный параметр, по умолчанию 14 (Почта России)

Получаем строку вида tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3 и полный url запроса

https://api.deliverycrm.ru/v1/track/history/v1/track/history?user_id=999999&request_key=b3c6236d57025ee7d37584059685b08cece8f3f9&tracks%5B0%5D%5Btrack%5D=18112831338669&tracks%5B1%5D%5Btrack%5D=BZXH10758710&tracks%5B1%5D%5Bservice_id%5D=3

Пример формирования url на php
<pre>
<?php

$tracks = [
['track' => '18112831338669'], // service_id по умолчанию = 14 (Почта Россиии)
['track' => 'BZXH10758710', 'service_id' => 3], // service_id = 3 (BoxBerry)
];

$userId = 999999;
$apiKey = '07dbd136d760e6be8fde6a2238992831';

$requestKey = sha1($userId . implode('', array_column($tracks, 'track')) . $apiKey);

$query = [
'user_id' => $userId,
'request_key' => $requestKey,
'tracks' => $tracks
];

$url = 'https://api.deliverycrm.ru/v1/track/history/v1/track/history?' . http_build_query($query);
</pre>

Пример ответа (JSON-формат):

<pre>[
'errors' => [
'tracks' => [
0 => 'Track at index \"0\" field \"track\" is required.'
]
]
'success' => true
'data' => [
0 => [
'track' => '504655'
'price' => 0
'total_price' => null
'created_at' => '2016-05-18 16:10:02'
'result' => 1
'status_history' => [
0 => [
'date' => '2016-05-18 11:38:00'
'status' => 'Доставлен'
'status_id' => 4501
]
]
'sms' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'segments' => 0
'internal_status' => 0
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'viber => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => 999
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'call' => [
0 => [
'message' => 'Посылка 504655 из TopDelivery готова!'
'internal_status' => -1
'call_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
'email' => [
0 => [
'theme' => 'Посылка 504655 из TopDelivery готова!'
'message' => 'Посылка 504655 из TopDelivery готова!'
'sent_at' => '2016-05-20 10:00:00'
'price' => 0
]
]
]
]
]</pre>

Расшифровка поля result

*STATE_FINISHED_SUCCESS = 1;
*STATE_IN_PROCESS = 2;
*STATE_FINISHED_UNKNOWN = 4;
*STATE_FINISHED_UNSUCCESSFUL = 5;

Расшифровка поля service_id

*TOP_DELIVERY = 1
*SPSR = 2
*BOXBERRY = 3
*PICKPOINT = 4
*SHOPLOGISTICS = 5
*BUSINESSLINES = 6
*SDEK = 7
*DPD = 8
*EXPRESS = 9
*PEK = 10
*CSE = 11
*DIMEX = 12
*RUSSIA_POST = 14
*UKRPOST = 13
*KZPOST = 15

Гибкая настройка схемы уведомлений с помощью условий

2020-10-19T10:37:31Z

Rlab:

Условия правил уведомления позволяют осуществить более гибкую настройку оповещения, опираясь на те или иные данные в заказе.

Для того, чтобы приступить к настройке, перейдите в нужную вам цепочку уведомлений.

Далее нужно выбрать правило, к которому Вы хотите применить условие.

[[Файл:Rule choose.jpg|1000px]]

Нажмите кнопку "Добавить Условие".

[[Файл:Add conf.jpg|500px]]

Вам на Выбор предоставлено 9 атрибутов условий:
- "Сумма заказа" 
- "Примечание к заказу" 
- "Количество возвратов" 
- "Тип оплаты" 
- "Пол" 
- "Регион" 
- "Вероятность выкупа" 
- "Доставка курьером" 

[[Файл:Conf vars.jpg|500px]]

=Типы схемы выполнения условий=

Каждое правило уведомления позволяет установить сразу несколько условий осуществления оповещений.
Добавив несколько условий для одного правила, Вам будут доступны на выбор две схемы выполнения этих условий: "Все условия" и "Хотя бы одно условие".

[[Файл:у9.jpg]]

=Все условия=

Установив, к примеру, все четыре условия описанные выше и выбрав схему выполнения условий "Все условия", данное правило уведомления будет работать исключительно для покупателя, чья сумма заказа более десяти тысяч рублей, примечание к его заказу не содержит слова "ремонт", количество возвратов от этого покупателя равно нулю и тип оплаты у него не предоплата, одновременно, то есть при выполнении всех условий.

[[Файл:у10.jpg]]

=Хотя бы одно условие=

Если установлена схема выполнения условий "Хотя бы одно условие", то в таком случае правило уведомления будет действовать для покупателя хотя бы с одним признаком, удовлетворяющим установленным условиям.

[[Файл:у11.jpg]]

Файл:AutoPay2.jpg

2020-10-19T10:08:46Z

Rlab:

Файл:AutoPay1.jpg

2020-10-19T10:07:45Z

Rlab:

Заглавная страница

2020-10-19T09:29:53Z

Rlab:

Добро пожаловать в Strekoza wiki!

Информация, которая размещена на данном ресурсе, поможет Вам усвоить функционал сервиса, правильно настроить его и продуктивно использовать в дальнейшем.

----
Внимание! Продукт непрерывно совершенствуется, в этой связи возможны расхождения отдельных страниц ресурса и текущего состояния сервиса. Стараясь оперативно устранять несоответствия, мы призываем Вас не переставать следить за интересующими страницами.

- [[Знакомство с личным кабинетом]]

- [[От какого имени отправляются СМС и как его изменить?]]

- [[Умное информирование]]

- [[Скоринг]]

- [[Гибкая настройка схемы уведомлений с помощью условий]]

- [[Добавление заказов]]

- [[Отзывы]]

- [[Автоплатежи]]

- [[Интеграции]]

- [[Восстановление отслеживания треков]]

- [[Telegram Bot]]

Отзывы

2020-10-19T09:29:25Z

Rlab: /* Настройка */

=Сервис сбора отзывов=

Если Вы собираете отзывы Ваших покупателей на каком-либо ресурсе, то этот сервис для Вас, если еще нет - значит самое время начать!

=Как это работает=

После получения посылки Ваши покупатели получают письмо с просьбой оценить работу магазина.

Далее сценарий меняется в зависимости от оценки. Если покупатель оценивает работу магазина хорошо - он оставляет отзыв на нужном Вам ресурсе, если плохо - попадает на форму для отправки жалобы в магазин. После заполнения формы, жалоба с указанием номера заказа, номера телефона и номера трека отправляется на указанную Вами электронную почту, после чего обрабатывается менеджером. Это позволит Вам максимально быстро решить проблему покупателя, перевести его в группу лояльных и в итоге сохранить клиента. Таким образом, Вы ограждаете свой бизнес от необоснованных негативных отзывов.

=Настройка=

Для того чтобы настроить автоматизированный сбор отзывов с сегментацией покупателей по уровню удовлетворенности, необходимо перейти в раздел "Отзывы", выбрать магазин для которого будет работать этот функционал и включить сервис.

После этого необходимо вставить ссылку на ресурс, где Вы будете собирать отзывы покупателей (ЯндексМаркет и прочее) для положительных оценок и адрес электронной почты для негативных.

Также на странице настроек Вам будет доступна вся статистика по отправленным письмам.

[[Файл:Otziv setup.jpg|1000px]]

Файл:Otziv setup.jpg

2020-10-19T09:29:10Z

Rlab: