ООО Восход

Заказы

Ресурсы

Ссылка Тип запроса Описание
/v1/orders GET Список заказов клиента
/v1/orders/:uid GET Содержимое заказа клиента
/v1/orders/deliveries GET Список адресов доставки клиента
/v1/orders POST Прямое оформление заказа (с переданным списком товаров)
/v1/orders/allin/:uids GET Содержимое заказов клиента, согласно списку идентификаторов

GET /v1/orders Список заказов клиента

Входные параметры

В URL запроса можно передать параметр page с указанием страницы разбиения

Ответ сервера

Возвращаются объекты page и orders или объект errors

Объект page имеет струкруту

Параметр Тип Описание
current Целое Текущая страница. По-умолчанию, 1
next Целое Следующая страница
prev Целое Предыдущая страница
pages Целое Всего страниц разбиения
items Целое Количество объектов

Объект orders имеет струкруту

Параметр Тип Описание
uid Строка Идентификатор заказа. Используется для получения информации о заказе
amount Вещественное Стоимость заказа
created_at Дата Дата создания заказа
updated_at Дата Дата обновления заказа
delivery_type Целое Тип доставки:
0 — самовывоз.
1 — доставка по указанному в параметре "delivery_address" адресу.
delivery_address Строка Адрес доставки
comment Строка Коментарий к заказу

Запрос JSON

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v1/orders.json

Ответ JSON

  {
    "response": {
      "page": {
        "current":1,
        "next":null,
        "prev":null,
        "pages":1,
        "items":2
      },
      "orders":[
        {
          "uid":"000001",
          "amount":33455.97,
          "created_at":"2016-04-17T11:14:32.030+05:00",
          "updated_at":"2016-04-17T12:50:18.256+05:00",
          "delivery_type":1,
          "delivery_address":"ул. Омская 101",
          "comment":""
        }, {
          "uid":"000002",
          "amount":117735.88,
          "created_at":"2016-03-20T14:50:19.548+05:00",
          "updated_at":"2016-04-10T11:40:22.413+05:00",
          "delivery_type":0,
          "delivery_address":"",
          "comment":""
        }
      ]
    }
  }

Запрос XML

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v1/orders.xml

Ответ XML

  <?xml version="1.0" encoding="UTF-8"?>
  <response>
    <page>
      <current>1</current>
      <next/>
      <prev/>
      <pages>1</pages>
      <items>2</items>
    </page>
    <orders>
      <order>
        <uid>000001</uid>
        <amount>33455.97</amount>
        <created_at>2016-04-17 11:14:32 +0500</created_at>
        <updated_at>2016-08-17 12:50:18 +0500</updated_at>
        <delivery_type>1</delivery_type>
        <delivery_address>ул. Омская 101</delivery_address>
        <comment></comment>
      </order>
      <order>
        <uid>000002</uid>
        <amount>117735.88</amount>
        <created_at>2016-03-20 14:50:19 +0500</created_at>
        <updated_at>2016-04-10 11:40:22 +0500</updated_at>
        <delivery_type>0</delivery_type>
        <delivery_address></delivery_address>
        <comment></comment>
      </order>
    </orders>
  </response>

GET /v1/orders/:uid Содержимое заказа пользователя

Входные параметры

В URL запроса необходимо указать идентификатор заказа в значении параметра uid

Ответ сервера

Возвращается объект order или объект errors

Параметр Тип Описание
uid Строка Идентификатор заказа. Используется для получения информации о заказе
amount Вещественное Стоимость заказа
created_at Дата Дата создания заказа
updated_at Дата Дата обновления заказа
delivery_type Целое Тип доставки:
0 — самовывоз.
1 — доставка по указанному в параметре "delivery_address" адресу.
delivery_address Строка Адрес доставки
comment Строка Коментарий к заказу
states_names Объект Строковый массив статусов товаров
cart_items Объект Массив товаров

Массив товаров cart_items имеет струкруту

Параметр Тип Описание
p_code Строка Код подставщика. По-умолчанию, "VNY6"
mog Строка Артикул номенклатуры в базе Восхода
oem_brand Строка Бренд производителя
oem_brand Строка Артикул производителя
name Строка Название номенклатуры
count Целое Количества товара в корзине
shipment Целое Кратность покупки
unit_code Целое Код единицы измерения
unit Целое Единица измерения
price Вещественное Стоимость товара для клиента
available Логическое Наличие товара
state_name Строка Статус обработки товара

Запрос JSON

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v1/orders/1234.json

Ответ JSON

  {
    "response": {
      "order":{
        "uid":"1234",
        "amount":33455.97,
        "created_at":"2016-04-17T11:14:32.030+05:00",
        "updated_at":"2016-04-17T12:50:18.256+05:00",
        "delivery_type":1,
        "delivery_address":"ул. Омская 101",
        "comment":"",
        "states_names": ["Сборка","Отменен","Обработка"],
        "items":[
          {
            "p_code":"VNY6",
            "mog":"35826t",
            "oem_brand":"Avtomark",
            "oem_num":"449",
            "name":"Краска карандаш + кисть 449 океан Avtomark 10 мл",
            "count":1,
            "shipment":1,
            "unit_code":796,
            "unit":"шт",
            "price":131.1,
            "available":true,
            "state_name":"Отгружен"
          }, {
            "p_code":"VNY6",
            "mog":"35803t",
            "oem_brand":"Avtomark",
            "oem_num":"202",
            "name":"Краска карандаш + кисть 202 белая Avtomark 10 мл",
            "count":1,
            "shipment":1,
            "unit_code":796,
            "unit":"шт",
            "price":131.1,
            "available":true,
            "state_name":"Отгружен"
          }, ..., {
            "p_code":"VNY6",
            "mog":"34829t",
            "oem_brand":"HOLEX",
            "oem_num":"HAS-2481",
            "name":"Краска аэрозольная Holex 601 черная 520 мл HAS-2481",
            "count":1,
            "shipment":1,
            "unit_code":796,
            "unit":"шт",
            "price":108.3,
            "available":true,
            "state_name":"Отгружен"
          }
        ]
      }
    }
  }

Запрос XML

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v1/orders/1234.xml

Ответ XML

  <?xml version="1.0" encoding="UTF-8"?>
  <response>
    <order>
      <uid>1234</uid>
      <amount>33455.97</amount>
      <created_at>2016-04-17 11:14:32 +0500</created_at>
      <updated_at>2016-08-17 12:50:18 +0500</updated_at>
      <delivery_type>1</delivery_type>
      <delivery_address>ул. Омская 101</delivery_address>
      <comment></comment>

      <states_names>
        <state_name>Сборка</state_name>
        <state_name>Отменен</state_name>
        <state_name>Обработка</state_name>
      </states_names>

      <items>
        <item>
          <p_code>VNY6</p_code>
          <mog>35826t</mog>
          <oem_brand>Avtomark</oem_brand>
          <oem_num>449</oem_num>
          <name>Краска карандаш + кисть 449 океан Avtomark 10 мл</name>
          <count>1</count>
          <shipment>1</shipment>
          <unit_code>796</unit_code>
          <unit>шт</unit>
          <price>131.1</price>
          <available>true</available>
          <state_name>Отгружен</state_name>
        </item>
        <item>
          <p_code>VNY6</p_code>
          <mog>35803t</mog>
          <oem_brand>Avtomark</oem_brand>
          <oem_num>202</oem_num>
          <name>Краска карандаш + кисть 202 белая Avtomark 10 мл</name>
          <count>1</count>
          <shipment>1</shipment>
          <unit_code>796</unit_code>
          <unit>шт</unit>
          <price>131.1</price>
          <available>true</available>
          <state_name>Отгружен</state_name>
        </item>
        ...
      </items>
    </order>
  </response>

GET /v1/orders/deliveries Список адресов доставки клиента

Входные параметры

В URL запроса можно передать параметр page с указанием страницы разбиения

Ответ сервера

Возвращаются объекты page и deliveries или объект errors

Объект page имеет струкруту

Параметр Тип Описание
current Целое Текущая страница. По-умолчанию, 1
next Целое Следующая страница
prev Целое Предыдущая страница
pages Целое Всего страниц разбиения
items Целое Количество объектов

Объект deliveries имеет струкруту

Параметр Тип Описание
name Строка Адрес доставки
updated_at Дата Дата последнего применения

Запрос JSON

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v1/orders/deliveries.json

Ответ JSON

  {
    "response": {
      "page": {
        "current":1,
        "next":null,
        "prev":null,
        "pages":1,
        "items":2
      },
      "deliveries":[
        {
          "name":"г. Миасс, ул. Советская, 9a",
          "updated_at":"2016-08-28T08:18:21.064+05:00"
        }, {
          "name":"ул. Тиирязева, 14",
          "updated_at":"2016-03-07T12:50:04.877+05:00"
        }
      ]
    }
  }

Запрос XML

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v1/orders/deliveries.xml

Ответ XML

  <?xml version="1.0" encoding="UTF-8"?>
  <response>
    <page>
      <current>1</current>
      <next/>
      <prev/>
      <pages>1</pages>
      <items>2</items>
    </page>
    <deliveries>
      <delivery>
        <name>г. Миасс, ул. Советская, 9a</name>
        <updated_at>2016-08-28 08:18:21 +0500</updated_at>
      </delivery>
      <delivery>
        <name>ул. Тиирязева, 14</name>
        <updated_at>2016-07-07 12:50:04 +0500</updated_at>
      </delivery>
    </deliveries>
  </response>

POST /v1/orders Прямое оформление заказа (с переданным списком товаров)

Входные параметры

Передается объект order с параметрами

Параметр Тип Описание
delivery_type Целое Тип доставки:
0 — самовывоз. Параметр "delivery_address" может быть пустым.
1 — доставка по указанному в параметре "delivery_address" адресу.
delivery_address Строка Адрес доставки
comment Строка Коментарий к заказу
items Объект Массив товаров

Объект items имеет струкруту

Параметр Тип Описание
p_code Строка Код поставщика. По-умолчанию, "VNY6"
oem_num Строка Артикул производителя
oem_brand Строка Бренд производителя
mog Строка Артикул номенклатуры в базе Восхода
count Целое Количество товара в корзине.
0 или меньше — товар удаляется,
больше нуля — в корзину добавляется указанное число товаров.

Выходные параметры

Возвращаются объекты order и items или объект errors

Объект order имеет струкруту

Параметр Тип Описание
uid Строка Идентификатор заказа. Используется для получения информации о заказе.
amount Вещественное Сумма заказа
delivery_type Целое Тип доставки:
0 — самовывоз.
1 — доставка по указанному в параметре "delivery_address" адресу.
delivery_address Строка Адрес доставки
comment Строка Коментарий к заказу

Объект items имеет струкруту

Параметр Тип Описание
p_code Строка Код подставщика. По-умолчанию, "VNY6"
mog Строка Артикул номенклатуры в базе Восхода
oem_brand Строка Бренд производителя
oem_brand Строка Артикул производителя
name Строка Название номенклатуры
count Целое Количества товара в корзине
shipment Целое Кратность покупки
unit_code Целое Код единицы измерения
unit Целое Единица измерения
price Вещественное Стоимость товара для клиента
available Логическое Наличие товара

Запрос JSON

  POST curl -X POST \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  -d '{"order":{"comment":"some comment", "delivery_type":"0", "delivery_address":"ул. Электростальская 47а", "items": [{"p_code":"VNY6", "oem_num":"KE024", "oem_brand":"MASUMA", "mog":"105589и", "count":"12"}, {"p_code":"VNY6", "oem_num":"KE124", "oem_brand":"MASUMA", "mog":"105876и", "count":"1"}] }}' \
  https://api.v-avto.ru/v1/orders.json

Ответ JSON

  {
    "response": {
      "order": {
        "uid":"8",
        "amount":192.0,
        "delivery_type":0,
        "delivery_address":"ул. Электростальская 47а",
        "comment":"some comment"
      },
      "items": [
        {
          "p_code":"VNY6",
          "mog":"105589и",
          "oem_brand":"MASUMA",
          "oem_num":"KE024",
          "name":"Пистон KE-024",
          "count":12,
          "shipment":10,
          "unit_code":796,
          "unit":"шт",
          "price":16.0,
          "available":true
        }
      ]
    }
  }

Запрос XML

  POST curl -X POST \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  -d '<order comment="Доставить к 16.00" delivery_type="1" delivery_address="ул. Электростальская 47а"/><item p_code="VNY6" oem_num="KE024" oem_brand="MASUMA" mog="105589и" count="12"/><item p_code="VNY6" oem_num="KE124" oem_brand="MASUMA" mog="105876и" count="1"/></order>' \
  https://api.v-avto.ru/v1/orders.xml

Ответ XML

  <?xml version="1.0" encoding="UTF-8"?>
  <response>
    <order>
      <uid>4</uid>
      <amount>1920.0</amount>
      <delivery_type>1</delivery_type>
      <delivery_address>ул. Электростальская 47а</delivery_address>
      <comment>Доставить к 16.00</comment>
    </order>
    <items>
      <item>
        <p_code>VNY6</p_code>
        <mog>105589и</mog>
        <oem_brand>MASUMA</oem_brand>
        <oem_num>KE024</oem_num>
        <name>Пистон KE-024</name>
        <count>20</count>
        <unit_code>796</unit_code>
        <unit>шт</unit>
        <price>16.0</price>
        <available>true</available>
      </item>
    </items>
  </response>

GET /v1/orders/allin/:uids Содержимое заказов клиента, согласно списку идентификаторов

Входные параметры

В URL запроса необходимо указать список идентификаторов заказов через запятую в значении параметра uids

Ответ сервера

Возвращается массив объектов orders или объект errors

Массив обьектов orders имеет объекты согласно структуре order

Запрос JSON

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v1/orders/allin/1234,5678.json

Ответ JSON

  {
    "response": {
      "orders":{
        "uid":"1234",
        "amount":33455.97,
        "created_at":"2016-04-17T11:14:32.030+05:00",
        "updated_at":"2016-04-17T12:50:18.256+05:00",
        "delivery_type":1,
        "delivery_address":"ул. Омская 101",
        "comment":"",
        "states_names": ["Сборка","Отменен","Обработка"],
        "items":[
          {
            "p_code":"VNY6",
            "mog":"35826t",
            "oem_brand":"Avtomark",
            "oem_num":"449",
            "name":"Краска карандаш + кисть 449 океан Avtomark 10 мл",
            "count":1,
            "shipment":1,
            "unit_code":796,
            "unit":"шт",
            "price":131.1,
            "available":true,
            "state_name":"Отгружен"
          }, {
            "p_code":"VNY6",
            "mog":"35803t",
            "oem_brand":"Avtomark",
            "oem_num":"202",
            "name":"Краска карандаш + кисть 202 белая Avtomark 10 мл",
            "count":1,
            "shipment":1,
            "unit_code":796,
            "unit":"шт",
            "price":131.1,
            "available":true,
            "state_name":"Отгружен"
          }, ..., {
            "p_code":"VNY6",
            "mog":"34829t",
            "oem_brand":"HOLEX",
            "oem_num":"HAS-2481",
            "name":"Краска аэрозольная Holex 601 черная 520 мл HAS-2481",
            "count":1,
            "shipment":1,
            "unit_code":796,
            "unit":"шт",
            "price":108.3,
            "available":true,
            "state_name":"Отгружен"
          }
        ]
      }, ... {
        "uid":"5678",
        "amount":2811.01,
        "created_at":"2016-04-17T10:11:32.030+05:00",
        "updated_at":"2016-04-17T12:51:00.256+05:00",
        "delivery_type":1,
        "delivery_address":"ул. Омская 101",
        "comment":"",
        "states_names": ["Отгружен"],
        "items":[
          {
            "p_code":"VNY6",
            "mog":"35826t",
            "oem_brand":"Avtomark",
            "oem_num":"449",
            "name":"Краска карандаш + кисть 449 океан Avtomark 10 мл",
            "count":1,
            "shipment":1,
            "unit_code":796,
            "unit":"шт",
            "price":131.1,
            "available":true,
            "state_name":"Отгружен"
          }, ..., {
            "p_code":"VNY6",
            "mog":"34829t",
            "oem_brand":"HOLEX",
            "oem_num":"HAS-2481",
            "name":"Краска аэрозольная Holex 601 черная 520 мл HAS-2481",
            "count":1,
            "shipment":1,
            "unit_code":796,
            "unit":"шт",
            "price":108.3,
            "available":true,
            "state_name":"Отгружен"
          }
        ]
      }
    }
  }

Запрос XML

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v1/orders/1234.xml

Ответ XML

  <?xml version="1.0" encoding="UTF-8"?>
  <response>
    <orders>

      <order>
        <uid>1234</uid>
        <amount>33455.97</amount>
        <created_at>2016-04-17 11:14:32 +0500</created_at>
        <updated_at>2016-08-17 12:50:18 +0500</updated_at>
        <delivery_type>1</delivery_type>
        <delivery_address>ул. Омская 101</delivery_address>
        <comment></comment>

        <states_names>
          <state_name>Сборка</state_name>
          <state_name>Отменен</state_name>
          <state_name>Обработка</state_name>
        </states_names>

        <items>
          <item>
            <p_code>VNY6</p_code>
            <mog>35826t</mog>
            <oem_brand>Avtomark</oem_brand>
            <oem_num>449</oem_num>
            <name>Краска карандаш + кисть 449 океан Avtomark 10 мл</name>
            <count>1</count>
            <shipment>1</shipment>
            <unit_code>796</unit_code>
            <unit>шт</unit>
            <price>131.1</price>
            <available>true</available>
            <state_name>Отгружен</state_name>
          </item>
          <item>
            <p_code>VNY6</p_code>
            <mog>35803t</mog>
            <oem_brand>Avtomark</oem_brand>
            <oem_num>202</oem_num>
            <name>Краска карандаш + кисть 202 белая Avtomark 10 мл</name>
            <count>1</count>
            <shipment>1</shipment>
            <unit_code>796</unit_code>
            <unit>шт</unit>
            <price>131.1</price>
            <available>true</available>
            <state_name>Отгружен</state_name>
          </item>
          ...
        </items>
      </order>

      <order>
        <uid>5678</uid>
        <amount>2811.01</amount>
        <created_at>2016-04-17 10:11:32 +0500</created_at>
        <updated_at>2016-08-17 12:51:00 +0500</updated_at>
        <delivery_type>1</delivery_type>
        <delivery_address>ул. Омская 101</delivery_address>
        <comment></comment>

        <states_names>
          <state_name>Отгружен</state_name>
        </states_names>

        <items>
          <item>
            <p_code>VNY6</p_code>
            <mog>35826t</mog>
            <oem_brand>Avtomark</oem_brand>
            <oem_num>449</oem_num>
            <name>Краска карандаш + кисть 449 океан Avtomark 10 мл</name>
            <count>1</count>
            <shipment>1</shipment>
            <unit_code>796</unit_code>
            <unit>шт</unit>
            <price>131.1</price>
            <available>true</available>
            <state_name>Отгружен</state_name>
          </item>
          <item>
            <p_code>VNY6</p_code>
            <mog>35803t</mog>
            <oem_brand>Avtomark</oem_brand>
            <oem_num>202</oem_num>
            <name>Краска карандаш + кисть 202 белая Avtomark 10 мл</name>
            <count>1</count>
            <shipment>1</shipment>
            <unit_code>796</unit_code>
            <unit>шт</unit>
            <price>131.1</price>
            <available>true</available>
            <state_name>Отгружен</state_name>
          </item>
          ...
        </items>
      </order>

    </orders>
  </response>