InSales API - Покупатели

Материал из Insales Wiki
Перейти к: навигация, поиск

Покупатели

Адрес: /admin/clients.

Возможные параметры запроса:

  • page, per_page - для листания клиентов, по умолчанию - 25 клиентов на странице. Чтобы получить все нужно в цикле листать страницы пока клиенты не закончатся


Атрибуты: email, name, surname, middlename, phone, password, registered, subscribe, default_address_attributes.

Обязательные атрибуты: name.

Значение registered = true означает, что покупатель зарегистрирован на сайте. При создании зарегистрированного клиента нужно указать email и пароль. При этом на указаный адрес отправляется письмо. Чтобы письмо не отправлялось, нужно передать в запросе поле skip_send_mail с любым значением.

Получение списка

GET /admin/clients.json

Ответ:

[
  {
    id: 1745543,
    name: "test",
    surname: "test",
    middlename: null,
    email: "test@tst.com",
    phone: "+79261111111",
    registered: false,
    subscribe: true,
    created_at: "2013-08-22T11:20:52+04:00",
    updated_at: "2013-08-22T11:20:52+04:00",
    bonus_points: 0,
    client_group_id: null
  }
]

GET /admin/clients.xml

Ответ:

<clients type="array">
  <client>
    <bonus-points type="integer">0</bonus-points>
    <client-group-id type="integer" nil="true"/>
    <created-at type="timestamp">2013-08-22 11:20:52 +0400</created-at>
    <email>test@tst.com</email>
    <id type="integer">1745543</id>
    <middlename nil="true"/>
    <name>test</name>
    <phone>+79261111111</phone>
    <registered type="boolean">false</registered>
    <subscribe type="boolean">true</subscribe>
    <surname>test</surname>
    <updated-at type="timestamp">2013-08-22 11:20:52 +0400</updated-at>
  </client>
</clients>

Создание

POST /admin/clients.json

Тело запроса:

  {
    name: "test",
    surname: "test"
  }

POST /admin/clients.xml

Тело запроса:

  <client>
    <name>test</name>
    <surname>test</surname>
  </client>

Просмотр

GET /admin/clients/1745543.json

Ответ:

  {
    id: 1745543,
    name: "test",
    surname: "test",
    middlename: null,
    email: "test@tst.com",
    phone: "+79261111111",
    registered: false,
    subscribe: true,
    created_at: "2013-08-22T11:20:52+04:00",
    updated_at: "2013-08-22T11:20:52+04:00",
    bonus_points: 0,
    client_group_id: null
  }


GET /admin/clients/1745543.xml

Ответ:

  <client>
    <bonus-points type="integer">0</bonus-points>
    <client-group-id type="integer" nil="true"/>
    <created-at type="timestamp">2013-08-22 11:20:52 +0400</created-at>
    <email>test@tst.com</email>
    <id type="integer">1745543</id>
    <middlename nil="true"/>
    <name>test</name>
    <phone>+79261111111</phone>
    <registered type="boolean">false</registered>
    <subscribe type="boolean">true</subscribe>
    <surname>test</surname>
    <updated-at type="timestamp">2013-08-22 11:20:52 +0400</updated-at>
  </client>

Редактирование

PUT /admin/clients/1745543.json

Тело запроса:

  {
    name: "test1",
    surname: "test1"
  }

PUT /admin/clients/1745543.xml

Тело запроса:

  <client>
    <name>test1</name>
    <surname>test1</surname>
  </client>

Удаление

DELETE /admin/clients/1745543.json

DELETE /admin/clients/1745543.xml