Сервис интеграции с 1С и другими программами бухгалтерского учета
Взаимодействие осуществляется через механизм веб-сервисов по протоколу SOAP, также сервис доступен через GET запросы.
Для использования через SOAP: WSDL веб-сервиса: http://урл-магазина/api/integration.php?wsdl (например для zizap.ru — http://zizap.ru/api/integration.php?wsdl)
Для GET: http://урл-магазина/api/integration.php (например http://zizap.ru/api/integration.php)
Метод «getUser» — поиск пользователей
Осуществляет поиск зарегистрированных клиентов магазина.
Метод getUser — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
userId | integer | нет | 1 | ID клиента магазина. При указании параметра будет найден только пользователь с указанным ID |
userId | array | нет | array(1,2,3) или userId[]=1&userId[]=2 для GET | ID клиентов магазина. При указании параметра будут найдены только пользователи с указанными ID |
| string | нет | user@mail.ru | Электронная почта клиента. При указании параметра будет найден пользователь с указанной почтой | |
registeredLater | datetime | нет | 2012-05-28 17:15:20 | При указании параметра будут найдены пользователи только зарегистрированные позже указанной даты |
registeredBefore | datetime | нет | 2013-05-28 17:15:20 | При указании параметра будут найдены пользователи только зарегистрированные раньше указанной даты |
daysFromRegistration | integer | нет | 5 | Количество дней со дня регистрации. При указании параметра будут найдены только те пользователи с момента регистрации прошло не больше дней, чем указанно в параметре |
Все параметры являются взаимодополняемыми, например если указать одновременно registeredLater и registeredBefore, то будут найдены пользователи зарегистрировавшиеся в указанный период времени.
Если вызвать метод без параметров указав только пароль доступа, то будут найдены все существующие пользователи.
Метод getUser — Возвращаемые данные
Метод возвращает массив объектов user, который содержит информацию о клиенте.
| Название | Пример | Описание |
|---|---|---|
id | 1 | Уникальный ID клиента |
| user@mail.ru | Электронная почта клиента | |
phone | 123456789 | Телефон клиента |
fio | Иванов Иван | ФИО клиента |
company | ООО «Иванов» | Название компании, если клиент Юр. лицо |
registrationdt | 2011-04-21 14:10:40 | Дата и время регистрации клиента |
creditlimit | 10000 | Кредитный лимит пользователя |
clientid | 000001 | Номер клиента |
additionalfields | Дополнительные поля с данными из конструктора форм регистрации |
Метод «getUserBalance» — Баланс клиента
Метод возвращает баланс пользователя с указанным ID или электронной почтой
Метод getUserBalance — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
userId | integer | да, если не указан email | 1 | ID клиента магазина (поле id в getUser). При указании параметра будет показан баланс клиента с данным ID |
| string | да, сли не указан userId | user@mail.ru | Электронная почта клиента. При указании параметра будет показан баланс клиента с указанной почтой |
Метод требует обязательного указания ID или электронной почты клиента
Метод getUserBalance — Возвращаемые данные
Метод возвращает объект balance, который содержит баланс клиента.
| Название | Пример | Описание |
|---|---|---|
balance | 123.99 | Текущий баланс клиента |
Метод «getPaymentOperationHistory» — История платежей
Метод возвращает историю платежей и списаний денег с баланса клиентов.
Метод getPaymentOperationHistory — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
userId | integer | нет | 1 | ID клиента магазина. При указании параметра будут найдены финансовые операции только пользователя с указанным ID |
userId | array | нет | array(1,2,3) или userId[]=1&userId[]=2 для GET | Массив ID клиентов магазина. При указании параметра будут найдены найдены финансовые операции только пользователей с указанными ID |
| string | нет | user@mail.ru | Электронная почта клиента. При указании параметра будут найдены финансовые операции только пользователя с указанной почтой | |
dateLater | datetime | нет | 2012-05-28 17:15:20 | При указании параметра будут найдены финансовые операции проводившиеся только позже указанной даты |
dateBefore | datetime | нет | 2013-05-28 17:15:20 | При указании параметра будут найдены финансовые операции проводившиеся только раньше указанной даты |
daysFrom | integer | нет | 5 | Количество дней. При указании параметра будет найдены только те финансовые операции с момента которых прошло не больше дней, чем указанно в параметре |
Все параметры являются взаимодополняемыми, например если указать одновременно dateLater и dateBefore, то будут найдены финансовые операции прводившиеся в указанный период времени. А если добавить userId, то только определенного пользователя.
Если вызвать метод без параметров указав только пароль доступа, то будут найдены все финансовые операции.
Метод getPaymentOperationHistory — Возвращаемые данные
Метод возвращает массив объектов operation, который содержит информацию о финансовых операциях.
| Название | Пример | Описание |
|---|---|---|
operationid | 1 | Уникальный ID операции |
operation | Наличный платеж | Название типа финансовой операции |
amount | 100.00 | Сума платежа |
orderid | 12 | Если это оплата счета, содержит ID счета |
comment | Комментарий к финансовой операции | |
userid | 1 | ID пользователя к которому относится данная операция |
useremail | user@mail.ru | Электронная почта пользователя к которому относится данная операция |
operationdt | 2011-04-21 14:10:40 | Дата и время операции |
manageruserid | 1 | Если платеж принимал менеджер, то содержит ID менеджера |
managerfio | Иванов Иван | Если платеж принимал менеджер, то содержит ФИО менеджера |
manageremail | manager@mail.ru | Если платеж принимал менеджер, то содержит электронную почту менеджера |
Метод «getOrder» — счета
Метод getOrder — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
id | integer | нет | 1 | ID счета. При указании параметра будут найден счет только с указанным ID |
id | array | нет | array(1,2,3) или id[]=1&id[]=2 для GET | Массив ID счетов. При указании параметра будут найдены счета только с указанными ID |
userId | integer | нет | 1 | ID клиента магазина. При указании параметра будут найдены счета только пользователя с указанным ID |
userId | array | нет | array(1,2,3) или userId[]=1&userId[]=2 для GET | Массив ID клиентов магазина. При указании параметра будут найдены счета только пользователей с указанными ID |
| string | нет | user@mail.ru | Электронная почта клиента. При указании параметра будут найдены счета только пользователя с указанной почтой | |
orderDateLater | datetime | нет | 2012-05-28 17:15:20 | При указании параметра будут найдены счета поступившие только позже указанной даты |
orderDateBefore | datetime | нет | 2013-05-28 17:15:20 | При указании параметра будут найдены счета поступившие только раньше указанной даты |
daysFromOrder | integer | нет | 5 | Количество дней. При указании параметра будет найдены только те счета с момента поступления которых прошло не больше дней, чем указанно в параметре |
Все параметры являются взаимодополняемыми, например если указать одновременно orderDateLater и orderDateBefore, то будут найдены счета поступившие в указанный период времени. А если добавить userId или email, то только определенного пользователя.
Если вызвать метод без параметров указав только пароль доступа, то будут найдены все счета.
Метод getOrder — Возвращаемые данные
Метод возвращает массив объектов order, который содержит информацию о счетах клиента.
| Название | Пример | Описание |
|---|---|---|
id | 1 | Уникальный ID счета |
userid | 2 | ID клиента, которому принадлежит счет |
| user@mail.ru | Электронная почта клиента | |
usercomment | Комментарий клиента к заказу | |
ordersum | 1034.00 | Сумма счета |
orderdate | datetime | Время создания счета |
payment | оплачен | Статус оплаты счета, может содержать «оплачен» или «не оплачен» |
Метод «getOrderItems» — заказанные запчасти
Метод getOrderItems — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
id | integer | нет | 1 | ID заказанной запчасти. При указании параметра будет найдена заказанная запчасть только с указанным ID. |
id | array | нет | array(1,2,3) или id[]=1&id[]=2 для GET | Массив ID заказанных запчастей. При указании параметра будут заказанные запчасти только с указанными ID |
orderId | integer | нет | 1 | ID счета. При указании параметра будут найдены заказанные запчасти только принадлежащие счету с указанным ID |
orderId | array | нет | array(1,2,3) или orderId[]=1&orderId[]=2 для GET | Массив ID счетов. При указании параметра будут найдены заказанные запчасти только принадлежащие счетам с указанными ID |
userId | integer | нет | 1 | ID клиента магазина. При указании параметра будут найдены заказанные запчасти только пользователя с указанным ID |
userId | array | нет | array(1,2,3) или userId[]=1&userId[]=2 для GET | Массив ID клиентов магазина. При указании параметра будут найдены заказанные запчасти только пользователей с указанными ID |
| string | нет | user@mail.ru | Электронная почта клиента. При указании параметра будут найдены заказанные запчасти только пользователя с указанной почтой | |
orderDateLater | datetime | нет | 2012-05-28 17:15:20 | При указании параметра будут найдены заказанные запчасти поступившие в заказ только позже указанной даты |
orderDateBefore | datetime | нет | 2013-05-28 17:15:20 | При указании параметра будут найдены заказанные запчасти поступившие в заказ только раньше указанной даты |
daysFromOrder | integer | нет | 5 | Количество дней. При указании параметра будет найдены только те заказанные запчасти с момента поступления которых прошло не больше дней, чем указанно в параметре |
Все параметры являются взаимодополняемыми, например если указать одновременно orderDateLater и orderDateBefore, то будут найдены заказанные запчасти поступившие в указанный период времени. А если добавить userId или email, то только определенного пользователя.
Если вызвать метод без параметров указав только пароль доступа, то будут найдены все заказанные запчасти.
Метод getOrderItems — Возвращаемые данные
Метод возвращает массив объектов orderitem, который содержит информацию о заказанных запчастях.
| Название | Пример | Описание |
|---|---|---|
id | 1 | Уникальный ID заказанной запчасти |
itemid | 100-02 | ID заказанной запчасти в бэкоффисе |
orderid | 124 | ID счета |
userid | 2 | ID клиента, которому принадлежит заказанная запчасть |
| user@mail.ru | Электронная почта клиента | |
usercomment | Комментарий клиента к заказу | |
managercomment | Комментарий менеджера к заказу | |
maker | NISSAN | Производитель заказанной запчасти |
article | CP03 | Артикул/Номер заказанной запчасти |
name | Несущий шарнир | Название запчасти |
quantity | 2 | Количество заказанных запчастей |
price | 130.40 | Цена заказанной запчасти |
total | 260.80 | Итоговая сумма (цена умноженная на количество) |
originalprice | 110.10 | Оригинальная цена заказанной запчасти указаная в прайсл-листе. В валюте магазина |
pricelistprice | 20 | Оригинальная цена заказанной запчасти указаная в прайсл-листе. В валюте прайс-листа. |
pricelistcurrency | RUR | Валюта прайс-листа |
oem | 123AA, CP03 | Номера замен (берутся с прайс-листа) |
applicability | TOYOTA CARINA E | Совместимость (берется с прайс-листа) |
orderdate | 2012-05-28 17:15:20 | Дата заказа |
changedate | 2012-05-28 17:15:20 | Дата и время последнего изменения статуса заказа |
expecteddelivery | 2012-05-28 17:15:20 | Ожидаемый срок поставки |
statusid | 2 | ID текущего статуса заказанной запчасти |
status | В работе | Текущий статус заказанной запчасти |
payment | оплачен | Оплачен или нет счет в которых входит данная запчасть |
pricelist | Оптовый Москва | Если заказанная запчасть с прайс-листа, содержит название прайс-листа |
supplier | emex.ru | Если заказанная запчасть от поставщика, содержит название поставщика |
manageruserid | 1 | ID менеджера |
managerfio | Иванов Иван | ФИО менеджера |
manageremail | manager@mail.ru | Электронная почта менеджера |
Метод «getStatusHistory» — история статусов запчастей
Метод getStatusHistory — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
orderItemId | integer | нет | 1 | ID заказанной запчасти (поле id возвращаемое в getOrderItems). При указании параметра будет найдена история смены статуса только указанной запчасти |
orderItemId | array | нет | array(1,2,3) или orderItemId[]=1&orderItemId[]=2 для GET | Массив ID заказанных запчастей (поле id возвращаемое в getOrderItems). При указании параметра будет найдена история смены статуса только указанных запчастей |
orderId | integer | нет | 1 | ID счета (поле id возвращаемое в getOrder). При указании параметра будет найдена история смены статуса запчастей входящих в этот счет |
orderId | array | нет | array(1,2,3) или orderId[]=1&orderId[]=2 для GET | Массив ID счетов (поле id возвращаемое в getOrder). При указании параметра будет найдена история смены статуса запчастей входящих в эти счета |
dateLater | datetime | нет | 2012-05-28 17:15:20 | При указании параметра будут найдена история смены статусов проводившиеся только позже указанной даты |
dateBefore | datetime | нет | 2013-05-28 17:15:20 | При указании параметра будут найдена история смены статусов проводившиеся только раньше указанной даты |
daysFrom | integer | нет | 5 | Количество дней. При указании параметра будут найдена история смены статусов только с момента которых прошло не больше дней, чем указанно в параметре |
Все параметры являются взаимодополняемыми, например если указать одновременно dateLater и dateBefore, то будут найдена история статусов за указанный период времени. А если добавить orderId, то только запчастей входящих в указанный счет.
Если вызвать метод без параметров, указав только пароль доступа, то будут найдена вся история смены статусов.
Метод getStatusHistory — Возвращаемые данные
| Название | Пример | Описание |
|---|---|---|
id | 1 | Уникальный ID |
orderid | 1 | ID счета |
orderitemid | 2 | ID заказанной запчасти (поле id в getOrderItems) |
statusid | 4 | ID статуса |
status | Принято | Название статуса |
comment | Комментарий | |
dt | 2012-05-28 17:15:20 | Дата и время установки статуса |
manageruserid | 8 | ID менеджера который установил статус (если статус установлен менеджером) |
managerfio | Иванов Иван | ФИО менеджера который установил статус (если статус установлен менеджером) |
manageremail | user@mail.ru | Электронная почта менеджера который установил статус (если статус установлен менеджером) |
Метод «getAllOrderStatuses» — Статусы запчастей
Метод getAllOrderStatuses — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
Метод getAllOrderStatuses — Возвращаемые данные
| Название | Пример | Описание |
|---|---|---|
id | 1 | Уникальный ID статуса |
name | Принято | Название статуса |
Метод «addPayment» — платежи
Метод addPayment — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
userId | integer | да, если не указан email | 1 | ID клиента магазина. Клиент которому заносятся деньги |
| string | да, если не указан userId | user@mail.ru | Электронная почта клиента которому заносятся деньги | |
amount | float | да | 100.00 | Сумма платежа, если указать с минусом (например -100), то будет произведено списание средств с баланса |
operationTypeId | integet | да | 100.00 | Тип операции. Допустимые значения: 1 — «Наличный платеж», 3 — «Корректировка», 4 — «Безналичный платеж» |
showPaymentOperation | bool | нет | true | Показать дванные принятого платежа. Если параметр указан, то вмето обьекта message, будет возвращен обьект paymentoperation с расширенной информацией о принятом платеже |
Метод требует обязательного указания userId или электронной почты клиента
Метод addPayment — Возвращаемые данные
Если не указан showPaymentOperation Метод возвращает объект message, который содержит сообщение об успешной завершении операции.
| Название | Пример | Описание |
|---|---|---|
message | Платеж суммой 100.00 добавлен. ID платежа 123 | Сообщение об успешном завершении платежа |
В случае возникновения ошибки, вернется обьект error c описанием ошибки.
Если указан параметр showPaymentOperation Метод возвращает объект paymentoperation, который содержит сообщение об успешной завершении операции и id оперции
| Название | Пример | Описание |
|---|---|---|
operationid | 123 | Уникальный ID платежа (поле operationid возвращаемое в getPaymentOperationHistory) |
message | Платеж суммой 100.00 добавлен. ID платежа 123 | Сообщение об успешном завершении платежа |
В случае возникновения ошибки, вернется обьект error c описанием ошибки.
Метод «getPartCrossNumber» — Кросс номера (oem, замены) запчасти
Метод getPartCrossNumber — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
article | string | да | CP03 | Артикул запчасти для которой нужно найти кросс номера |
maker | string | нет | JAPANPARTS | Производитель запчасти для которой нужно найти кросс номера. Если производиель не указан, то кросс номера будут надены для всех запчастей с данным номером |
Метод требует обязательного указания ID или электронной почты клиента
Метод getPartCrossNumber — Возвращаемые данные
Метод возвращает массив объектов oem, который содержит список кросс номеров искомой запчасти.
| Название | Пример | Описание |
|---|---|---|
article | N571N19 | Артикул замены |
maker | NPS | Производитель замены |
Метод «setOrderPaymentState» — Оплата счета клиента с баланса
Метод setOrderPaymentState — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
userId | integer | да, если не указан email | 1 | ID клиента магазина. Клиент которому заносятся деньги |
| string | да, если не указан userId | user@mail.ru | Электронная почта клиента которому заносятся деньги | |
orderId | integer | да | 1234 | ID(номер) счета |
displayAdditionalInformation | integer | нет | 1 | Отображать подробную информацию в результате работы функции |
Метод требует обязательного указания userId или электронной почты клиента
Метод setOrderPaymentState — Возвращаемые данные
Метод возвращает объект message, который содержит сообщение об успешной завершении операции.
| Название | Пример | Описание |
|---|---|---|
message | Счет №1448 успешно оплачен. | Сообщение об успешной оплате |
В случае возникновения ошибки (счет уже оплачен, недостаточно средств), вернется обьект error c описанием ошибки.
Если указан параметр displayAdditionalInformation в результате будет возвращен обьект orderpaymetstate c сообщением об успешной завершении операци и id операции
| Название | Пример | Описание |
|---|---|---|
message | Счет №1448 успешно оплачен. | Сообщение об успешной оплате |
paymentoperation | ID операции оплаты в элементе operationid |
Метод «setOrderItemStatus» — Смена статуса заказанной запчасти
Метод setOrderItemStatus — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
orderItemId | integer | да | 219796 | ID заказанной запчасти |
orderItemId | array | да | array(219796,219797) или orderItemId[]=219796&orderItemId[]=219797 для GET | Несколько ID заказанных запчастей в виде массив. Допускается не более 100 запчастей в массиве в одном запросе. |
statusId | integer | да | 1 | Новый ID статуса заказанной запчасти(-тей) |
comment | string | нет | Комментарий в формате URL encoding |
Метод setOrderItemStatus — возвращаемые данные
Метод возвращает объект message, который содержит сообщение об успешном завершении операции.
| Название | Пример | Описание |
|---|---|---|
message | Статус заказа изменен | Сообщение об успешной смене статуса |
В случае возникновения ошибки, вернется обьект error c описанием ошибки.
| Название | Пример | Описание |
|---|---|---|
error | Невозможно изменить статус заказа | Сообщение об ошибке |
При групповой смене статуса возвращается обьект errors который может содержать несколько обьектов error с ошибкой на каждую запчасть .
Метод «setMultipleOrderItemStatus» — Групповая смена статусов для множества запчастей
Метод setMultipleOrderItemStatus — входные параметры
| Название | Тип | Обязательное поле | Пример | Описание |
|---|---|---|---|---|
password | string | да | 12345 | Пароль для доступа к сервису интеграции |
orderItems | array | да | array(44 = array(statusId = 2), 45 = array(statusId = 2, comment = "%D0%9A%D0%BE%D0%BC")) или orderItems[44][statusId]=2&orderItems[45][statusId]=2&orderItems[45][comment]=%D0%9A%D0%BE%D0%BC для GET | Двумерный массив, следующей структуры: в качестве ключа необходимо указать ID заказанной запчасти, в качестве значения — массив содержащий обязательное поле statusId, равный ID нового статуса заказанной запчасти и не обязательное поле comment, для передачи комментария к заказанной запчасти в формате URL encoding. |
Метод setMultipleOrderItemStatus — возвращаемые данные
Метод возвращает объект message, который содержит сообщение об успешном завершении операции, в случае если все переданные в массиве запчасти обработались без ошибок.
| Название | Пример | Описание |
|---|---|---|
message | Статусы заказов изменены | Сообщение об успешной смене статусов |
В случае возникновения ошибки, вернется обьект error c описанием ошибки.
| Название | Пример | Описание |
|---|---|---|
error | Неверно указан ID статуса заказа | Сообщение об ошибке |
Если было выявлено несколько ошибок то возвращается обьект errors который может содержать несколько обьектов error с ошибкой на каждую запчасть .
Метод «getMakers» — список всех производителей запчастей с синонимами
Метод getMakers — Возвращаемые данные
Метод возвращает массив объектов makers, который содержит информацию о производителе.
| Название | Пример | Описание |
|---|---|---|
id | 1 | Уникальный ID производителя |
name | ABS | Название производителя запчасти |
synonyms | Если у производителя есть синонимы. То возвращается массив обьектов synonyms содержащий синонимы производителя запчастей. |
Структура synonym, которая содержит информацию о синониме производителя запчастей.
| Название | Пример | Описание |
|---|---|---|
id | 10 | Уникальный ID синонима |
name | A.B. S. | Название |
Смотрите также
Создание C# Web — сервисов
1С: Предприятие 8 Web — сервисы, во избежание проблем с использованием SOAP сервисов из 1С, желательно их использование через «MS SOAP Toolkit 3.0». Либо через GET запросы.