ООО Восход

Заказы

Ресурсы

Ссылка Тип запроса Описание
/v2/orders GET Список заказов клиента
/v2/orders/{{order_id}} GET Сведения о заказе по идентификатору
/api/v2/orders/{{order_id}}/cart_items GET Сведения о товарных позициях в заказе
/api/v2/orders/{{order_id}}/history POST История статусов заказа по номеру заказа
/v2/cart_items/{{cart_item_id}}/history GET История статусов товарной позиции в заказе по номеру
/v2/order_statuses GET Словарь статусов
/v2/products/{{product_id}} GET Карточка товара по идентификатору товара
/v2/products/{{product_id}}/images GET Медиаконтент карточки товара

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

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

В URL запроса можно передать параметры:
• page с указанием страницы разбиения
• limit с указание количества заказов на одну страницы

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

Возвращается ключ next_page: Boolean и масиив объектов orders

Элемент массива orders имеет струкруту

Параметр Тип Описание
id Целое Идентификатор заказа. Используется для получения информации о заказе
uid Строка Номер заказа
amount Вещественное Стоимость заказа
outlet Строка Идентификатор адреса доставки / выдачи заказа
Для получения сведений о выбранном адресе необходимо вызвать метод outlets
delivery_period Массив Выбранный пользователем при оформлении заказа желаемый период доставки.
Содержит ключи:
• end_time: Data — конец периода,
• start_time: Data — начало периода.
comment Строка Комментарий к заказу
status_uid Строка Код статуса заказа
status_date Дата Время присвоения статуса
allow_split Логическое Опция «Доставка заказа по частям»
express_delivery Логическое Опция «Курьерская доставка»
created_at Дата Дата создания заказа
updated_at Дата Дата последнего изменнения полей заказа

Запрос JSON

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

Ответ JSON

  {
      "next_page": true,
      "orders": [
          {
              "id": 757544,
              "uid": "757544",
              "amount": 2639.1,
              "outlet": "357b2a19-872f-11ed-badf-003048f6ad93",
              "delivery_period": {
                  "end_time": "2023-07-14T21:30",
                  "start_time": "2023-07-14T21:00"
              },
              "comment": "",
              "status_uid": "new",
              "status_date": null,
              "allow_split": false,
              "express_delivery": false,
              "created_at": "2023-07-13T18:42:48.271+05:00",
              "updated_at": "2023-07-14T13:45:34.137+05:00"
          },
          {
              "id": 757675,
              "uid": "757675",
              "amount": 381.99,
              "outlet": "6d3b3f7e-9519-11ed-badf-003048f6ad93",
              "delivery_period": null,
              "comment": "DEV_TEST_API_ORDER_BASKET",
              "status_uid": "shipping",
              "status_date": "2023-08-04T14:58:32.000+05:00",
              "allow_split": false,
              "express_delivery": false,
              "created_at": "2023-08-04T14:26:45.342+05:00",
              "updated_at": "2023-08-04T14:58:32.384+05:00"
          },
      ]
  }

GET /v2/orders/{{order_id}} Сведения о заказе по идентификатору

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

В URL запроса необходимо указать идентификатор заказа {{order_id}}

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

Параметр Тип Описание
id Целое Идентификатор заказа. Используется для получения информации о заказе
uid Строка Номер заказа
amount Вещественное Стоимость заказа
outlet Строка Идентификатор адреса доставки или точки выдачи заказа
Для получения сведений о выбранном адресе необходимо вызвать метод outlets
delivery_period Массив Выбранный пользователем при оформлении заказа желаемый период доставки.
Содержит ключи:
• end_time: Data — конец периода,
• start_time: Data — начало периода.
comment Строка Комментарий к заказу
status_uid Строка Код статуса заказа
status_date Дата Время присвоения статуса
allow_split Логическое Опция «Доставка заказа по частям»
express_delivery Логическое Опция «Курьерская доставка»
created_at Дата Дата создания заказа
updated_at Дата Дата последнего изменнения полей заказа

Запрос JSON

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

Ответ JSON

  {
      "id": 757675,
      "uid": "757675",
      "amount": 381.99,
      "outlet": "6d3b3f7e-9519-11ed-badf-003048f6ad93",
      "delivery_period": null,
      "comment": "DEV_TEST_API_ORDER",
      "status_uid": "shipping",
      "status_date": "2023-08-04T14:58:32.000+05:00",
      "allow_split": false,
      "express_delivery": false,
      "created_at": "2023-08-04T14:26:45.342+05:00",
      "updated_at": "2023-08-04T14:58:32.384+05:00"
  }

GET /api/v2/orders/{{order_id}}/cart_items Сведения о товарных позициях в заказе

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

В URL запроса можно передать параметры:
• page с указанием страницы разбиения
• limit с указание количества заказов на одну страницы

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

Возвращается ключ next_page: Boolean и масиив объектов cart_items

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

Параметр Тип Описание
id Целое Идентификатор товарной позиции (строки)
uid Строка Дополнительный системный идентификатор товарной позиции
product_id Целое Идентификатор карточки товара
product_uid Строка Дополнительный системный идентификатор карточки товара
title Строка Название товара
brand Строка Название бренда (производителя)
oem_num Строка Артикул производителя
va_num Строка Артикул поставщика
provider Строка Идентификатор поставщика
product_url Строка URL-адрес карточки товара в формате параметра для адреса https://v-avto.ru/product/{{url}}
unit_code Целое Код единицы измерения по ОКЕИ
unit Строка Единица измерения
count Целое Количество единиц товара по позиции
price Вещественное Стоимость одной единицы по позиции
delivery_at Строка Расчетное время доставки — начало периода
delivery_till Строка Расчетное время доставки — конец периода
notices Строка Комментарий к товарной позиции
status_uid Строка Идентификатор статуса товарной позиции
status_date Строка Дата присвоения статуса товарной позиции

Запрос JSON

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

Ответ JSON

  {
      "next_page": false,
      "cart_items": [
          {
              "id": 13118467,
              "uid": "cad0b26b-a5db-478c-b820-29311c207111",
              "product_id": 155844111,
              "product_uid": null,
              "title": "Шланг D= 8*15,5 (10 атм.) маслобензостойкий (отрезки 7-10 м) ВПТ",
              "brand": "ВПТ",
              "oem_num": "8Х15063",
              "va_num": "21305g",
              "provider": "VNY6",
              "product_url": "shlang-d-8155-10-atm-maslobenzostoykiy-otrezki-7-10-m-vpt-405267c7-38e0-11e3-afa4-003048f6ad92",
              "unit_code": 6,
              "unit": "м",
              "count": 1,
              "price": 97.19,
              "delivery_at": "0001-01-01T01:32:16.000+04:02",
              "delivery_till": null,
              "notices": "",
              "status_uid": "shipping",
              "status_date": "2023-08-04T14:58:31.000+05:00"
          },
          {}
      ]
  }

GET /api/v2/orders/{{order_id}}/history История статусов заказа по номеру заказа

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

В URL запроса необходимо указать идентификатор заказа {{order_id}}

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

Возвращаются массив объектов статусов заказа

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

Параметр Тип Описание
id Целое Идентификатор записи в истории статусов заказа
order_id Целое Идентификатор заказа
status_uid Строка Код статуса
status_date Строка Время присвоения статуса
created_at Строка Дата создания записи статуса. Сервисное поле.
updated_at Строка Дата изменения записи статуса. Сервисное поле.

Запрос JSON

  POST curl -X POST \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v2/orders/1234/history

Ответ JSON

  [
      {
          "id": 62,
          "order_id": 757675,
          "status_uid": "confirm",
          "status_date": "2023-08-04T14:39:06.000+05:00",
          "created_at": "2023-08-04T14:39:06.718+05:00",
          "updated_at": "2023-08-04T14:39:06.718+05:00"
      },
      {
          "id": 63,
          "order_id": 757675,
          "status_uid": "sent",
          "status_date": "2023-08-04T14:39:31.000+05:00",
          "created_at": "2023-08-04T14:39:30.970+05:00",
          "updated_at": "2023-08-04T14:39:30.970+05:00"
      }
  ]

GET /v2/cart_items/{{cart_item_id}}/history История статусов товарной позиции в заказе по номеру

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

В URL запроса необходимо указать идентификатор товарной позиции {{cart_item_id}}

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

Возвращается массив объектов со статусами товарной позиции

Статус товарной позиции имеет структуру

Параметр Тип Описание
status_uid Строка Код статуса
status_date Строка Время присвоения статуса

Запрос JSON

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v2/cart_items/654321/history

Ответ JSON

  [
      {
          "status_uid": "confirm",
          "status_date": "2023-08-04T14:39:07.000+05:00"
      },
      {
          "status_uid": "sent",
          "status_date": "2023-08-04T14:39:31.000+05:00"
      },
      {
          "status_uid": "kit",
          "status_date": "2023-08-04T14:52:28.000+05:00"
      },
      {
          "status_uid": "transfer",
          "status_date": "2023-08-04T14:53:03.000+05:00"
      },
      {
          "status_uid": "shipping",
          "status_date": "2023-08-04T14:55:01.000+05:00"
      },
      {
          "status_uid": "transfer",
          "status_date": "2023-08-04T14:55:06.000+05:00"
      },
      {
          "status_uid": "shipping",
          "status_date": "2023-08-04T14:58:32.000+05:00"
      }
  ]

GET /v2/order_statuses Словарь статусов

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

Возвращается объектов с сопоставлением ключей статустов и их названий на русском.
Список статусов может быть изменён.

Запрос JSON

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

Ответ JSON

  {
      "new": "Оформлен",
      "vendor": "Заказан у поставщика",
      "confirm": "Подтвержден",
      "cancel": "Отменен",
      "stock": "Поступил на склад",
      "sent": "Отправлен на сборку",
      "kit": "Сборка",
      "set": "Собран",
      "transfer": "Передается в доставку",
      "shipping": "В доставке",
      "ready": "Готов к выдаче в ПВЗ",
      "done": "Получен"
  }

GET /v2/products/{{product_id}} Карточка товара по идентификатору товара

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

В URL запроса необходимо указать идентификатор товарной позиции {{product_id}}

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

Возвращается объект карточки товара

Карточка товара имеет структуру

Параметр Тип Описание
id Целое Идентификатор карточки товара
oem_num Строка Артикул производителя
va_catalog_id Строка Идентификатор каталога
updated_at Строка Дата изменения карточки товара
shipment Целое Кратность покупки
va_item_id Строка Дополнительный идентификатор товара. Сервисное поле.
unit_code Целое Код единицы измерения
instituted_at Строка Дата создания карточки товара
url Строка URL-адрес карточки товара в формате параметра для адреса https://v-avto.ru/product/{{url}}
allow_online_payment Строка Признак доступности оплаты товара картой на сайте
description Строка Описание товара
uid Строка Сервисный идентификатор карточки
provider Строка Код поставщика
brand Строка Бренд производителя
va_num Строка Артикул поставщика
title Строка Название товара

Запрос JSON

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v2/products/11111111

Ответ JSON

  {
      "id": 155844111,
      "oem_num": "8Х15063",
      "va_catalog_id": "bd894830-38df-11e3-afa4-003048f6ad92",
      "updated_at": "2023-07-27T18:25:14.498+05:00",
      "shipment": 1,
      "va_item_id": "405267c7-38e0-11e3-afa4-003048f6ad92",
      "unit_code": 6,
      "instituted_at": "2013-10-19T02:00:00.000+06:00",
      "url": "shlang-d-8155-10-atm-maslobenzostoykiy-otrezki-7-10-m-vpt-405267c7-38e0-11e3-afa4-003048f6ad92",
      "allow_online_payment": true,
      "description": "",
      "uid": null,
      "provider": "VNY6",
      "brand": "ВПТ",
      "va_num": "21305g",
      "title": "Шланг D= 8*15,5 (10 атм.) маслобензостойкий (отрезки 7-10 м) ВПТ"
  }

GET /v2/products/{{product_id}}/images Медиаконтент карточки товара

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

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

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

Возвращается массив строк со ссылками на медиаконтент (изображения, видео) карточки товара

Запрос JSON

  GET curl \
  -H "X-Voshod-API-KEY: 393-QBjhK44xUrbgduYHdANoLWdZx8eiPKCUQDvxU2v6MdiPnadQzLUBpYBHWKkg7gGYj9VcMyYif55Qd3g5" \
  https://api.v-avto.ru/v2/products/160707180/images

Ответ JSON

  [
      "/exchange_1c/From1C/f2048727-d051-11e9-9765-801844ec8e35_1.jpg?1692616811"
  ]