Основы uAPI

Документация uAPI по модулям

Во всех PHP примерах запроса используется PHP модуль uAPI
Заказы | Категории магазина | Корзина магазина | Товары | Валюта
Главная > Документация uAPI > Модуль "Интернет-магазин", заказы
 

[GET] Данные для оформления


Получить данные для начала оформления заказа

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ 'success': { ORDER_DATA } }

Дополнительные параметры запроса

  • promo_code=PROMO – [Строка] – промокод
  • custom_delivery_tax=TAX – [Строка] – такса за доставку заказа. Учитывается, если для способа доставки по умолчанию отмечен параметр “Использовать модуль расчёта стоимости доставки” и для которого указано значение “Внешний калькулятор”

Расшифровка ответа

ORDER_DATA - секция с данными заказа. Если корзина пуста, то секция будет содержать поле “msg” с текстом “Ваша корзина пуста”, иначе секция будет содержать следующие поля:

  • num_entries – суммарное количество товарных позиций в заказе
  • order_content – секция с информацией по товарам заказа
  • order_fields – секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей
  • order_data – секция с данными заказа
  • payment_list – секция со списком доступных способов оплаты. ID подсекции - ID способа оплаты
  • current_payment_id – ID выбранного способа оплаты (значение по умолчанию - первой ID в списке способов оплаты)
  • delivery_list – cекция со списком доступных способов доставки. ID подсекции - ID способа доставки
  • current_delivery_id – ID выбранного способа оплаты (значение по умолчанию - первой ID в списке способов доставки)

ORDER_CONTENT - секция с информацией по товарам заказа. Секция содержит следующие поля:

  • order_goods – секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в корзине
  • order_goods_fields – секция со списком полей товара, где ключ записи - название поля. Каждая подсекция содержит поля: name - подпись поля, pos - позиция поля в списке полей.

ORDER_GOODS_LIST - секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в корзине. Набор полей секции зависит от настроки “Отображение полей товара в заказе” на странице “Управление полями заказа” магазина. Секция содержит следующие поля:

  • goods_id – ID товара *
  • name – значение поля “Наименование”
  • price – цена товара *
  • cnt – количество товара в заказе *
  • sum – стоимость товара с учетом его количества в заказе *
  • vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • warning – предупреждения по товару (например, если товара нет в наличие на момент оформления заказа) *
  • cat – секция с данными о категории товара. cat_id - ID категории. cat_name - название категории
  • img – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. photo - URL к полному изображению товара
  • art – значение поля “Артикул”
  • brand – значение поля “Производитель”
  • warr – значение поля “Гарантия”
  • weight – значение поля “Вес”
  • unit – значение поля “Единица”
  • options – выбранные опции товара
  • otherN – значение поля “Дополнительное поле N”. Количество дополнительных полей зависит от настроек магазина, но не может быть больше девяти
  • added_user – логин пользователя, добавившего товар

* Всегда присутствует, не зависимо от настройки “Отображение полей товара в заказе”

ORDER_FILEDS - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей. Список полей зависит от настроки “Дополнительные поля формы заказа” на странице “Управление полями заказа” магазина. Каждая подсекция содержит следующие поля:

  • name – название поля
  • type – тип поля (text, textarea, checkbox, file, email, phone, promo, select, radio, gmaps)
  • required – значение опции “Обязательное поле”
  • pos – позиция поля в списке полей
  • sel_val – значение поля, указанное пользователем либо заполненное на основании данных пользователя (если поле ассоциировано с полем из карточки пользователя). Поле отсутствует для типа “gmaps”
  • autoreg – значение опции “Авторегистрация” для гостевых заказов. Присутствует при наличии поля с типом “email” и соответствующих настроек в модуле “Пользователи”
  • autoreg_reject – значение опции “Позволять покупателям отказываться от авторегистрации” для гостевых заказов. Присутствует при наличии поля с типом “email” и соответствующих настроек в модуле “Пользователи”
  • values – список значений поля. Поле присутствует только для типов “select” и “radio”
  • addr – адрес, указанный пользователем. Поле присутствует только для типа “gmaps”
  • lat – lat координата адреса, указанного пользователем. Поле присутствует только для типа “gmaps”
  • lng – long координата адреса, указанного пользователем. Поле присутствует только для типа “gmaps”

ORDER_DATA - секция с данными заказа. Секция содержит следующие поля:

  • order_info – дополнительная информация по заказу
  • order_notice – сообщения с предупреждениями и предложениями по заказу. Предложения содержатся в поле “notice”. Предупреждения содержатся в поле “notice_err”
  • order_uid – ID пользователя, который оформляет заказ
  • order_weight – суммарный вес заказа
  • order_amount – cумарная стоимость товарных позиций в заказе
  • order_tax – такса за доставку заказа, если она задана в текущем способе доставки
  • order_total – итого по заказу с учётом таксы за доставку товара
  • order_vat – НДС от суммы "К оплате" (order_topay
  • order_discount – сумма дисконтной скидки на заказ, если активирована дисконтная система
  • order_topay – сумма к оплате выбранным способом с учётом дисконтной скидки

PAYMENT_LIST - секция со списком доступных способов оплаты. ID подсекции - ID способа оплаты. Каждая подсекция содержит следующие

  • name – название способа оплаты
  • dscr – описание способа оплаты
  • module – модуль электронных платежей, привязанный к способу оплаты
  • status – статус способа оплаты (доступен/недоступен)
  • pos – позиция способа оплаты в списке способов оплаты
  • delivery_assoc – секция со списком связей способа оплаты со способами доставки.

DELIVERY_LIST - секция со списком доступных способов доставки. ID подсекции - ID способа доставки. Каждая подсекция содержит следующие поля:

  • name – название способа доставки
  • dscr – описание способа доставки
  • module – модуль расчёта стоимости доставки
  • courier – значение опции “Использовать своих курьеров”
GETSHOP /uapi/shop/checkout/
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/checkout/', array( //без параметров )); print_r($response); //Получаем ответ ?>
{ "success":{ "delivery_list":{ "1":{ "courier":0, "dscr":"Товар вы можете получить по прибытию в наш офис", "name":"Самовывоз", "module":"" }, "3":{ "courier":0, "dscr":"Описание способа доставки", "name":"Способ доставки № 3", "module":"" }, "2":{ "courier":0, "dscr":"Описание способа доставки", "name":"Способ доставки № 2", "module":"" } }, "order_content":{ "order_goods":{ "6":{ "other3":"", "vat":"0.00$", "options":"Размер: L", "other1":"", "brand":"", "img":{ "small":"http://yoursite.ucoz.ru/_sh/00/10s.jpg", "photo":"http://yoursite.ucoz.ru/_sh/00/10.jpg" }, "cat":{ "cat_name":"Одежда", "cat_id":"4" }, "weight":"", "sum":{ "sum":"51.00$", "sum_raw":51 }, "art":"", "name":"Футболка New Torso", "other2":"", "warr":"", "cnt":"1", "added_user":"Tom", "goods_id":"10", "unit":"", "warning":"", "price":{ "price":"51.00$", "price_raw":51 } } }, "order_goods_fields":{ "other3":{ "name":"Дополнительное поле 3", "pos":13 }, "vat":{ "name":"НДС", "pos":10 }, "options":{ "name":"Опции товара", "pos":5 }, "other1":{ "name":"Дополнительное поле 1", "pos":11 }, "brand":{ "name":"Производитель", "pos":3 }, "img":{ "name":"Фото", "pos":0 }, "cat":{ "name":"Категория", "pos":1 }, "weight":{ "name":"Вес", "pos":7 }, "sum":{ "name":"Удалить", "pos":16 }, "art":{ "name":"Артикул", "pos":2 }, "name":{ "name":"Наименование", "pos":4 }, "other2":{ "name":"Дополнительное поле 2", "pos":12 }, "warr":{ "name":"Гарантия", "pos":6 }, "cnt":{ "name":"Кол-во", "pos":15 }, "added_user":{ "name":"Владелец", "pos":9 }, "unit":{ "name":"Единица", "pos":8 }, "price":{ "name":"Цена", "pos":14 } } }, "order_fields":{ "1":{ "required":1, "sel_val":"", "name":"Контактный телефон", "pos":1, "type":"phone" }, "2":{ "required":1, "sel_val":"", "name":"Адрес доставки", "pos":2, "type":"textarea" } }, "payment_list":{ "1":{ "status":"active", "dscr":"Рассчитаться можно с курьером наличными при получении товара", "name":"Наличными при получении", "pos":1, "delivery_assoc":"", "module":"" }, "3":{ "status":"active", "dscr":"Описание способа оплаты", "name":"Способ оплаты № 3", "pos":3, "delivery_assoc":"", "module":"" }, "2":{ "status":"active", "dscr":"Описание способа оплаты", "name":"Способ оплаты № 2", "pos":2, "delivery_assoc":"", "module":"" } }, "order_data":{ "order_tax":{ "tax_raw":0, "tax":0 }, "order_notice":{ "notice":"", "notice_err":"" }, "order_uid":"1", "order_weight":{ "weight":"0.00", "weight_raw":0 }, "order_discount":{ "discount_raw":0, "discount":0 }, "order_info":"", "order_amount":{ "amount_raw":51, "amount":"51.00$" }, "order_vat":{ "vat_raw":0, "vat_type":"0", "vat":0 }, "order_total":{ "total_raw":51, "total":"51.00$" }, "order_topay":{ "topay":"51.00$", "topay_curr":"51.00$", "topay_raw":51 } }, "current_payment_id":1, "current_delivery_id":1, "num_entries":1 } }
 

[PUT] Пересчет неоформленного заказа


С помощью запроса можно сделать перерасчет товара, так как в нем могли изменить параметры

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ 'success': { ORDER_DATA } }

Дополнительные параметры запроса

  • cnt_REC_ID=GOODS_CNT – [Число] – количество единиц товара. REC_ID - ID записи товарной позиции в заказе
  • del_REC_ID=1 – [Число] – признак удаления единицы товара из заказа. REC_ID - ID записи товарной позиции в заказе

Расшифровка ответа

ORDER_DATA - секция с данными заказа. Если корзина пуста, то секция будет содержать поле “msg” с текстом “Ваша корзина пуста”, иначе секция будет содержать следующие поля:

  • num_entries – суммарное количество товарных позиций в заказе
  • order_content – секция с информацией по товарам заказа
  • order_fields –  ORDER_FILEDS - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей
  • order_data –  секция с данными заказа
  • payment_list – секция со списком доступных способов оплаты. ID подсекции - ID способа оплаты
  • current_payment_id –  ID выбранного способа оплаты (значение по умолчанию - первой ID в списке способов оплаты)
  • delivery_list – секция со списком доступных способов доставки. ID подсекции - ID способа доставки 
  • current_delivery_id –  ID выбранного способа оплаты (значение по умолчанию - первой ID в списке способов доставки)

ORDER_CONTENT - секция с информацией по товарам заказа. Секция содержит следующие поля:

  • order_goods –  секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в корзине
  • order_goods_fields –  секция со списком полей товара, где ключ записи - название поля. Каждая подсекция содержит поля: name - подпись поля, pos - позиция поля в списке полей.

ORDER_GOODS_LIST - секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в корзине. Набор полей секции зависит от настройки “Отображение полей товара в заказе” на странице “Управление полями заказа” магазина. Секция содержит следующие поля:

  • goods_id – ID товара *
  • name – значение поля “Наименование”
  • price – цена товара *
  • cnt – количество товара в заказе *
  • sum – стоимость товара с учетом его количества в заказе *
  • vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • warning – предупреждения по товару (например, если товара нет в наличие на момент оформления заказа) *
  • cat – секция с данными о категории товара. cat_id - ID категории. cat_name - название категории
  • img – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. photo - URL к полному изображению товара
  • art – значение поля “Артикул”
  • brand – значение поля “Производитель”
  • warr – значение поля “Гарантия”
  • weight – значение поля “Вес”
  • unit – значение поля “Единица”
  • options – выбранные опции товара
  • otherN – значение поля “Дополнительное поле N”. Количество дополнительных полей зависит от настроек магазина, но не может быть больше девяти
  • added_user – логин пользователя, добавившего товар

* Всегда присутствует, не зависимо от настройки “Отображение полей товара в заказе”

ORDER_FILEDS - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей. Список полей зависит от настроки “Дополнительные поля формы заказа” на странице “Управление полями заказа” магазина. Каждая подсекция содержит следующие поля:

  • name – название поля
  • type – тип поля (text, textarea, checkbox, file, email, phone, promo, select, radio, gmaps)
  • required – значение опции “Обязательное поле”
  • pos – позиция поля в списке полей
  • sel_val – значение поля, указанное пользователем либо заполненное на основании данных пользователя (если поле ассоциировано с полем из карточки пользователя). Поле отсутствует для типа “gmaps”
  • autoreg – значение опции “Авторегистрация” для гостевых заказов. Присутствует при наличии поля с типом “email” и соответствующих настроек в модуле “Пользователи”
  • autoreg_reject – значение опции “Позволять покупателям отказываться от авторегистрации” для гостевых заказов. Присутствует при наличии поля с типом “email” и соответствующих настроек в модуле “Пользователи”
  • values – список значений поля. Поле присутствует только для типов “select” и “radio”
  • addr – адрес, указанный пользователем. Поле присутствует только для типа “gmaps”
  • lat – lat координата адреса, указанного пользователем. Поле присутствует только для типа “gmaps”
  • lng – long координата адреса, указанного пользователем. Поле присутствует только для типа “gmaps”

ORDER_DATA - секция с данными заказа. Секция содержит следующие поля:

  • order_info – дополнительная информация по заказу
  • order_notice – сообщения с предупреждениями и предложениями по заказу. Предложения содержатся в поле “notice”. Предупреждения содержатся в поле “notice_err”
  • order_uid – ID пользователя, который оформляет заказ
  • order_weight – суммарный вес заказа
  • order_amount – cумарная стоимость товарных позиций в заказе
  • order_tax – такса за доставку заказа, если она задана в текущем способе доставки
  • order_total – итого по заказу с учётом таксы за доставку товара
  • order_vat – НДС от суммы "К оплате" (order_topay
  • order_discount – сумма дисконтной скидки на заказ, если активирована дисконтная система
  • order_topay – сумма к оплате выбранным способом с учётом дисконтной скидки

PAYMENT_LIST - секция со списком доступных способов оплаты. ID подсекции - ID способа оплаты. Каждая подсекция содержит следующие

  • name – название способа оплаты
  • dscr – описание способа оплаты
  • module – модуль электронных платежей, привязанный к способу оплаты
  • status – статус способа оплаты (доступен/недоступен)
  • pos – позиция способа оплаты в списке способов оплаты
  • delivery_assoc – секция со списком связей способа оплаты со способами доставки.

DELIVERY_LIST - секция со списком доступных способов доставки. ID подсекции - ID способа доставки. Каждая подсекция содержит следующие поля:

  • name – название способа доставки
  • dscr – описание способа доставки
  • module – модуль расчёта стоимости доставки
  • courier – значение опции “Использовать своих курьеров”
POSTSHOP /uapi/shop/checkout/?mode=recalc
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/shop/checkout/', array( 'mode'=>'recalc' )); print_r($response); //Получаем ответ ?>
{ "success":{ "delivery_list":{ "1":{ "courier":0, "dscr":"Товар вы можете получить по прибытию в наш офис", "name":"Самовывоз", "module":"" }, "3":{ "courier":0, "dscr":"Описание способа доставки", "name":"Способ доставки № 3", "module":"" }, "2":{ "courier":0, "dscr":"Описание способа доставки", "name":"Способ доставки № 2", "module":"" } }, "order_content":{ "order_goods":{ "6":{ "other3":"", "vat":"0.00$", "options":"Размер: L", "other1":"", "brand":"", "img":{ "small":"http://yoursite.ucoz.ru/_sh/00/10s.jpg", "photo":"http://yoursite.ucoz.ru/_sh/00/10.jpg" }, "cat":{ "cat_name":"Одежда", "cat_id":"4" }, "weight":"", "sum":{ "sum":"51.00$", "sum_raw":51 }, "art":"", "name":"Футболка New Torso", "other2":"", "warr":"", "cnt":"1", "added_user":"Tom", "goods_id":"10", "unit":"", "warning":"", "price":{ "price":"51.00$", "price_raw":51 } } }, "order_goods_fields":{ "other3":{ "name":"Дополнительное поле 3", "pos":13 }, "vat":{ "name":"НДС", "pos":10 }, "options":{ "name":"Опции товара", "pos":5 }, "other1":{ "name":"Дополнительное поле 1", "pos":11 }, "brand":{ "name":"Производитель", "pos":3 }, "img":{ "name":"Фото", "pos":0 }, "cat":{ "name":"Категория", "pos":1 }, "weight":{ "name":"Вес", "pos":7 }, "sum":{ "name":"Удалить", "pos":16 }, "art":{ "name":"Артикул", "pos":2 }, "name":{ "name":"Наименование", "pos":4 }, "other2":{ "name":"Дополнительное поле 2", "pos":12 }, "warr":{ "name":"Гарантия", "pos":6 }, "cnt":{ "name":"Кол-во", "pos":15 }, "added_user":{ "name":"Владелец", "pos":9 }, "unit":{ "name":"Единица", "pos":8 }, "price":{ "name":"Цена", "pos":14 } } }, "order_fields":{ "1":{ "required":1, "sel_val":"", "name":"Контактный телефон", "pos":1, "type":"phone" }, "2":{ "required":1, "sel_val":"", "name":"Адрес доставки", "pos":2, "type":"textarea" } }, "payment_list":{ "1":{ "status":"active", "dscr":"Рассчитаться можно с курьером наличными при получении товара", "name":"Наличными при получении", "pos":1, "delivery_assoc":"", "module":"" }, "3":{ "status":"active", "dscr":"Описание способа оплаты", "name":"Способ оплаты № 3", "pos":3, "delivery_assoc":"", "module":"" }, "2":{ "status":"active", "dscr":"Описание способа оплаты", "name":"Способ оплаты № 2", "pos":2, "delivery_assoc":"", "module":"" } }, "order_data":{ "order_tax":{ "tax_raw":0, "tax":0 }, "order_notice":{ "notice":"", "notice_err":"" }, "order_uid":"1", "order_weight":{ "weight":"0.00", "weight_raw":0 }, "order_discount":{ "discount_raw":0, "discount":0 }, "order_info":"", "order_amount":{ "amount_raw":51, "amount":"51.00$" }, "order_vat":{ "vat_raw":0, "vat_type":"0", "vat":0 }, "order_total":{ "total_raw":51, "total":"51.00$" }, "order_topay":{ "topay":"51.00$", "topay_curr":"51.00$", "topay_raw":51 } }, "current_payment_id":1, "current_delivery_id":1, "num_entries":1 } }
 

[PUT] Изменение неоформленного заказа


Изменение параметров неоформленнного заказа

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ 'success': { ORDER_DATA } }

Дополнительные параметры запроса

  • payment_id=PAYMANT_ID – [Число] – ID способа оплаты из списка доступных способов оплаты
  • delivery_id=DELIVERY_ID – [Число] – ID способа доставки из списка доступных способов доставки
  • fldN=FIELD_N – [Строка] – значение дополнительного поля заказа, где N - порядковый номер дополнительного поля в списке полей заказа
  • gmap_a=ADDRESS – [Строка] – адрес для поля типа “gmaps”
  • gmap_s=ADDRESS – [Строка] – значение lat координаты для поля типа “gmaps”
  • gmap_d=ADDRESS – [Строка] – значение long координаты для поля типа “gmaps”
  • custom_delivery_tax=TAX – [Строка] – такса за доставку заказа. Учитывается, если для указанного в “delivery_id” способа оплаты отмечен параметр “Использовать модуль расчёта стоимости доставки” и для которого указано значение “Внешний калькулятор”

Расшифровка ответа

ORDER_DATA - секция с данными заказа. Если корзина пуста, то секция будет содержать поле “msg” с текстом “Ваша корзина пуста”, иначе секция будет содержать следующие поля:

  • num_entries – суммарное количество товарных позиций в заказе
  • order_content – секция с информацией по товарам заказа
  • order_fields –  ORDER_FILEDS - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей
  • order_data –  секция с данными заказа
  • payment_list – секция со списком доступных способов оплаты. ID подсекции - ID способа оплаты
  • current_payment_id –  ID выбранного способа оплаты (значение по умолчанию - первой ID в списке способов оплаты)
  • delivery_list – секция со списком доступных способов доставки. ID подсекции - ID способа доставки 
  • current_delivery_id –  ID выбранного способа оплаты (значение по умолчанию - первой ID в списке способов доставки)

ORDER_CONTENT - секция с информацией по товарам заказа. Секция содержит следующие поля:

  • order_goods –  секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в корзине
  • order_goods_fields –  секция со списком полей товара, где ключ записи - название поля. Каждая подсекция содержит поля: name - подпись поля, pos - позиция поля в списке полей.

ORDER_GOODS_LIST - секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в корзине. Набор полей секции зависит от настройки “Отображение полей товара в заказе” на странице “Управление полями заказа” магазина. Секция содержит следующие поля:

  • goods_id – ID товара *
  • name – значение поля “Наименование”
  • price – цена товара *
  • cnt – количество товара в заказе *
  • sum – стоимость товара с учетом его количества в заказе *
  • vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • warning – предупреждения по товару (например, если товара нет в наличие на момент оформления заказа) *
  • cat – секция с данными о категории товара. cat_id - ID категории. cat_name - название категории
  • img – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. photo - URL к полному изображению товара
  • art – значение поля “Артикул”
  • brand – значение поля “Производитель”
  • warr – значение поля “Гарантия”
  • weight – значение поля “Вес”
  • unit – значение поля “Единица”
  • options – выбранные опции товара
  • otherN – значение поля “Дополнительное поле N”. Количество дополнительных полей зависит от настроек магазина, но не может быть больше девяти
  • added_user – логин пользователя, добавившего товар

* Всегда присутствует, не зависимо от настройки “Отображение полей товара в заказе”

ORDER_FILEDS - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей. Список полей зависит от настроки “Дополнительные поля формы заказа” на странице “Управление полями заказа” магазина. Каждая подсекция содержит следующие поля:

  • name – название поля
  • type – тип поля (text, textarea, checkbox, file, email, phone, promo, select, radio, gmaps)
  • required – значение опции “Обязательное поле”
  • pos – позиция поля в списке полей
  • sel_val – значение поля, указанное пользователем либо заполненное на основании данных пользователя (если поле ассоциировано с полем из карточки пользователя). Поле отсутствует для типа “gmaps”
  • autoreg – значение опции “Авторегистрация” для гостевых заказов. Присутствует при наличии поля с типом “email” и соответствующих настроек в модуле “Пользователи”
  • autoreg_reject – значение опции “Позволять покупателям отказываться от авторегистрации” для гостевых заказов. Присутствует при наличии поля с типом “email” и соответствующих настроек в модуле “Пользователи”
  • values – список значений поля. Поле присутствует только для типов “select” и “radio”
  • addr – адрес, указанный пользователем. Поле присутствует только для типа “gmaps”
  • lat – lat координата адреса, указанного пользователем. Поле присутствует только для типа “gmaps”
  • lng – long координата адреса, указанного пользователем. Поле присутствует только для типа “gmaps”

ORDER_DATA - секция с данными заказа. Секция содержит следующие поля:

  • order_info – дополнительная информация по заказу
  • order_notice – сообщения с предупреждениями и предложениями по заказу. Предложения содержатся в поле “notice”. Предупреждения содержатся в поле “notice_err”
  • order_uid – ID пользователя, который оформляет заказ
  • order_weight – суммарный вес заказа
  • order_amount – cумарная стоимость товарных позиций в заказе
  • order_tax – такса за доставку заказа, если она задана в текущем способе доставки
  • order_total – итого по заказу с учётом таксы за доставку товара
  • order_vat – НДС от суммы "К оплате" (order_topay
  • order_discount – сумма дисконтной скидки на заказ, если активирована дисконтная система
  • order_topay – сумма к оплате выбранным способом с учётом дисконтной скидки

PAYMENT_LIST - секция со списком доступных способов оплаты. ID подсекции - ID способа оплаты. Каждая подсекция содержит следующие

  • name – название способа оплаты
  • dscr – описание способа оплаты
  • module – модуль электронных платежей, привязанный к способу оплаты
  • status – статус способа оплаты (доступен/недоступен)
  • pos – позиция способа оплаты в списке способов оплаты
  • delivery_assoc – секция со списком связей способа оплаты со способами доставки.

DELIVERY_LIST - секция со списком доступных способов доставки. ID подсекции - ID способа доставки. Каждая подсекция содержит следующие поля:

  • name – название способа доставки
  • dscr – описание способа доставки
  • module – модуль расчёта стоимости доставки
  • courier – значение опции “Использовать своих курьеров”
POSTSHOP /uapi/shop/checkout/?mode=change
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/shop/checkout/', array( 'mode'=>'change' )); print_r($response); //Получаем ответ ?>
{ "success":{ "delivery_list":{ "1":{ "courier":0, "dscr":"Товар вы можете получить по прибытию в наш офис", "name":"Самовывоз", "module":"" }, "3":{ "courier":0, "dscr":"Описание способа доставки", "name":"Способ доставки № 3", "module":"" }, "2":{ "courier":0, "dscr":"Описание способа доставки", "name":"Способ доставки № 2", "module":"" } }, "order_content":{ "order_goods":{ "6":{ "other3":"", "vat":"0.00$", "options":"Размер: L", "other1":"", "brand":"", "img":{ "small":"http://yoursite.ucoz.ru/_sh/00/10s.jpg", "photo":"http://yoursite.ucoz.ru/_sh/00/10.jpg" }, "cat":{ "cat_name":"Одежда", "cat_id":"4" }, "weight":"", "sum":{ "sum":"51.00$", "sum_raw":51 }, "art":"", "name":"Футболка New Torso", "other2":"", "warr":"", "cnt":"1", "added_user":"Tom", "goods_id":"10", "unit":"", "warning":"", "price":{ "price":"51.00$", "price_raw":51 } } }, "order_goods_fields":{ "other3":{ "name":"Дополнительное поле 3", "pos":13 }, "vat":{ "name":"НДС", "pos":10 }, "options":{ "name":"Опции товара", "pos":5 }, "other1":{ "name":"Дополнительное поле 1", "pos":11 }, "brand":{ "name":"Производитель", "pos":3 }, "img":{ "name":"Фото", "pos":0 }, "cat":{ "name":"Категория", "pos":1 }, "weight":{ "name":"Вес", "pos":7 }, "sum":{ "name":"Удалить", "pos":16 }, "art":{ "name":"Артикул", "pos":2 }, "name":{ "name":"Наименование", "pos":4 }, "other2":{ "name":"Дополнительное поле 2", "pos":12 }, "warr":{ "name":"Гарантия", "pos":6 }, "cnt":{ "name":"Кол-во", "pos":15 }, "added_user":{ "name":"Владелец", "pos":9 }, "unit":{ "name":"Единица", "pos":8 }, "price":{ "name":"Цена", "pos":14 } } }, "order_fields":{ "1":{ "required":1, "sel_val":"", "name":"Контактный телефон", "pos":1, "type":"phone" }, "2":{ "required":1, "sel_val":"", "name":"Адрес доставки", "pos":2, "type":"textarea" } }, "payment_list":{ "1":{ "status":"active", "dscr":"Рассчитаться можно с курьером наличными при получении товара", "name":"Наличными при получении", "pos":1, "delivery_assoc":"", "module":"" }, "3":{ "status":"active", "dscr":"Описание способа оплаты", "name":"Способ оплаты № 3", "pos":3, "delivery_assoc":"", "module":"" }, "2":{ "status":"active", "dscr":"Описание способа оплаты", "name":"Способ оплаты № 2", "pos":2, "delivery_assoc":"", "module":"" } }, "order_data":{ "order_tax":{ "tax_raw":0, "tax":0 }, "order_notice":{ "notice":"", "notice_err":"" }, "order_uid":"1", "order_weight":{ "weight":"0.00", "weight_raw":0 }, "order_discount":{ "discount_raw":0, "discount":0 }, "order_info":"", "order_amount":{ "amount_raw":51, "amount":"51.00$" }, "order_vat":{ "vat_raw":0, "vat_type":"0", "vat":0 }, "order_total":{ "total_raw":51, "total":"51.00$" }, "order_topay":{ "topay":"51.00$", "topay_curr":"51.00$", "topay_raw":51 } }, "current_payment_id":1, "current_delivery_id":1, "num_entries":1 } }
 

[POST] Оформление заказа


* Поля могут быть и необязательными, если для них в настройках не установлен параметр “Обязательное поле”
  • payment_id=PAYMENT_ID – [Число] – ID способа оплаты из списка доступных способов оплаты
  • delivery_id=DELIVERY_ID – [Число] – ID способа доставки из списка доступных способов доставки
  • fldN=FIELD_N – [Строка] – значение дополнительного поля заказа, где N - порядковый номер дополнительного поля в списке полей заказа
  • gmap_a=ADDRESS – [Строка] – адресс для поля типа “gmaps”
  • gmap_s=ADDRESS – [Строка] – значение lat координаты для поля типа “gmaps”
  • gmap_d=ADDRESS – [Строка] – значение long координаты для поля типа “gmaps”

С помощью запроса можно осуществить оформление заказа

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ "msg":"Ваш заказ успешно оформлен" } }

Дополнительные параметры запроса

  • custom_delivery_tax=TAX – [Строка] – такса за доставку заказа. Учитывается, если для указанного в “delivery_id” способа оплаты отмечен параметр “Использовать модуль расчёта стоимости доставки” и для которого указано значение “Внешний калькулятор”
  • shop_autoreg=1 – [Число] – значение параметра “Регистрация”. Используется для авторегистрации гостя
POSTSHOP /uapi/shop/checkout/?mode=order&payment_id=PAYMENT_ID&delivery_id=DELIVERY_ID&fldN=FIELD_N&gmap_a=ADDRESS&gmap_s=ADDRESS&gmap_d=ADDRESS
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->post('/shop/checkout/', array( 'mode' => 'order', 'payment_id' => 'PAYMENT_ID', 'delivery_id' => 'DELIVERY_ID', 'fldN' => 'FIELD_N', 'gmap_a' => 'ADDRESS', 'gmap_s' => 'ADDRESS', 'gmap_d' => 'ADDRESS' )); print_r($response); //Получаем ответ ?>
{ "success":{ "msg":"Ваш заказ успешно оформлен" } }
 

[GET] Мои заказы


С помощью запроса можно осуществить получение всех своих заказов

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Дополнительные параметры запроса

  • page=PAGE_ID – [Число] – номер текущей страницы выборки (значение по умолчанию - 1)
  • per_page=NUM – [Число] – количество заказов на страницу (максимальное значение и значение по умолчанию - 20)
  • sort=FIELD_NAME – [Строка] – поле по которуму будет отсортирован список заказов Возможные значения:
    'id' - по ID (значение по умолчанию)
    'user' - по пользователям
    'cnt' - по количеству
    'amount' - по сумме заказа
    'status' - по статусу
    'add_date' - по дате добавления
    'mod_time' - по дате модификации
    'payment_id' - по способу оплаты
    'delivery_id' - по способу доставки
  • order=SORT_MODE – [Строка] – режим сортировки
    Возможные значения:
    'asc' - по возврастанию (значение по умолчанию)
    'desc' - по убыванию
  • user=USER_ID – [Число] – фильтр - ID пользователя, сформировавшего заказ. Будут отобраны заказы указанного пользователя. Учитывается, только если пользователь, от имени которого делается запрос, имеет права администратора
  • hide=HIDE_ID – [Число] – фильтр - группа заказа. Будут отобраны заказы, которые относятся к указанной группе заказов. !!! Список всех групп можно получить с помощью отдельного запроса - см. раздел “Получение списка групп заказа”.
    Возможные значения:
    0 - В работе
    1 - В архиве
    2 - В корзине
  • status=STATUS_ID – [Число] – фильтр - статус заказа. Будут отобраны заказы, которые имеют указанный статус!!! Список всех групп можно получить с помощью отдельного запроса - см. раздел “Получение списка статусов заказа”.
    Возможные значения:
    0 - Новый
    1 - Оплачивается
    2 - Оплачен
    3 - В обработке
    4 - Готов
    5 - Доставляется
    7 - Доставлен
    8 - Завершён
    9 - Отменён
  • inv_sum=SUM – [Строка] – фильтр - диапазон сумм заказов в формате "sum1|sum2". Будут отобраны заказы, сумма которых попадает в указанный диапазон сумм
  • courier=COURIER – [Строка] – фильтр - курьер. Будут отобраны заказы, котором назначен указанный курьер
  • cdate=DATES – [Строка] – фильтр - период доставки в формате "date1|date2". Будут отобраны заказы у которых период доставки попадает в указанный период. !!! date1 и date2 должны соответствовать формату “YYYY-MM-DD HH:MI:SS”, где YYYY - год, MM - месяц, DD - день, HH - часы, MI - минуты, SS - секунды. Время является необязательной частью.
  • payment=PAYMЕNT_ID – [Число] – фильтр - ID способа облаты. Будут отобраны заказы с указанным способом оплаты
  • delivery=DELIVERY_ID – [Число] – фильтр - ID способа доставки. Будут отобраны заказы с указанным способом доставки
  • id=IDS – [Строка] – фильтр - ID заказа(ов), перечисленных через запятую. Будут отобраны заказы с указанными ID
  • date=DATES – [Строка] – фильтр - диапазон дат добавления в формате "date1|date2". Будут отобраны заказы, дата добавления которых попадает в указанный период. !!! date1 и date2 должны соответствовать формату “YYYY-MM-DD HH:MI:SS”, где YYYY - год, MM - месяц, DD - день, HH - часы, MI - минуты, SS - секунды. Время является необязательной частью.

Расшифровка ответа сервера

DATA - секция с данными. Секция содержит следующие поля:

  • orders – секция с данными о заказах. Данная секция содержит список подсекций с данными по каждому заказу. ID подсекции - порядковый номер подсекции в списке подсекций
  • order_status – cписок всех возможных статусов заказа
  • order_fields – секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей
  • order_hide – список всех возможных групп заказа
  • order_uids – список ID пользователей, заказы которых попали в выборку
  • count – суммарное количество заказов, попавших в выборку
  • page – текущая страница выборки
  • pages_cnt – количество страниц выборки
  • per_page – количество заказов на одной странице выборки
  • total – оборотная сумма по заказам попавшим в выборку
  • profit – суммарная прибыль по заказам попавшим в выборку

ORDERS - секция с данными о заказах. Данная секция содержит список подсенкций с данными по каждому закаазу. ID подсекции - порядковый номер подсекции в списке подсекций. Каждая подсекция содержит следующие поля:

  • id – ID заказа (номер заказа)
  • nom – отформатированный ID заказа (номер заказа)
  • order_hash – хэш id заказа для получения или изменения даны по заказу
  • uid – ID пользователя, оформившего заказ
  • user – логин пользователя, оформившего заказ
  • akey – ключ для формирования auth-ссылки на страницу просмотра заказа
  • cnt – количество товаров в заказе
  • amount – cумарная стоимость товарных позиций в заказе
  • profit – суммарная прибыль по заказу
  • discount – информация о скидке по заказу, где sum - сумма скидки, promo_code - примененный промокод, promo_group - тип промо-кода
  • currency – валюта, в которой был оформлен заказ, где id - ID валюты, в которой был оформлен заказ, rate - курс валюты на момент оформления заказа
  • payment – информация о способе оплаты заказа, где id - ID способа оплаты заказа, topay - сумма к оплате выбранным способом с учётом дисконтной скидки
  • delivery – информация о способе доставки заказа, где id - ID способа доставки заказа, tax - такса за доставку заказа, courier - курьер, назначенный для доставки заказа, delivery_date - дата доставки заказа
  • weight – суммарный вес заказа
  • fields – секция со значениями дополнительных полей заказа
  • map – секция с информацией об адресе google maps, если в списке дополнительных полей есть поле типа “gmaps”, где address - указанный адрес, latitude - значение lat координаты, longitude - значение long координаты
  • status – статус заказа
  • hide – группа, к которой относится заказ (0 - “В работе”, 1 - “В архиве”, 2 - “В корзине”)
  • add_date – дата добавления заказа
  • mod_date – дата последнего изменения заказа
  • rem – лог заказа
  • note – примечания к заказу
  • ip – ip, с которого был сделан заказ
  • refhost – хост реферальной ссылки с которой пришел пользователь
  • referer – URL реферальной ссылки с которой пришел пользователь

ORDER_FILEDS - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей. Список полей зависит от настройки “Дополнительные поля формы заказа” на странице “Управление полями заказа” магазина. Каждая подсекция содержит следующие поля:

  • name – название поля
  • type – тип поля (text, textarea, checkbox, file, email, phone, promo, select, radio, gmaps)
  • required – значение опции “Обязательное поле”
  • pos – позиция поля в списке полей
  • sel_val – значение поля, указанное пользователем либо заполненное на основании данных пользователя (если поле ассоциировано с полем из карточки пользователя). Поле отсутствует для типа “gmaps”
  • autoreg – значение опции “Авторегистрация” для гостевых заказов. Присутствует при наличии поля с типом “email” и соответствующих настроек в модуле “Пользователи”
  • autoreg_reject – значение опции “Позволять покупателям отказываться от авторегистрации” для гостевых заказов. Присутствует при наличии поля с типом “email” и соответствующих настроек в модуле “Пользователи”
  • values – список значений поля. Поле присутствует только для типов “select” и “radio”
  • addr – адрес, указанный пользователем. Поле присутствует только для типа “gmaps”
  • lat – lat координата адреса, указанного пользователем. Поле присутствует только для типа “gmaps”
  • lng – long координата адреса, указанного пользователем. Поле присутствует только для типа “gmaps”
GETSHOP /uapi/shop/invoices/
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/invoices/', array( //без параметров )); print_r($response); //Получаем ответ ?>
{ "success":{ "count":"2", "page":1, "orders":[ { "order_hash":"UqTzDXQDXQMW3yE2cfI5p4lur1zUPEiVskfgy%3Boo", "delivery":{ "tax":"0.00", "id":"3" }, "weight":"300", "user":"Dmitry_DM", "id":"1", "mod_date":"1458511535", "uid":"1", "discount":{ "sum":"0.00" }, "cnt":"1", "hide":"0", "rem":"-----< 21.03.2016 01:05 >-----------------------------------
Пользователь Dmitry_DM оформил заказ

", "nom":"00001", "status":"0", "ip":"178.204.152.179", "currency":{ "rate":"1", "id":"1" }, "add_date":"1458511535", "payment":{ "topay":"500.00$", "id":"2" }, "profit":"180.00", "amount":"500.00", "fields":{ "1":"312312312", "2":"312312312" }, "akey":"e4b52bf982e95c031584bdd61b43613f" }, { "order_hash":"UqTzDXQDXQMV3yE2cfI5peQa9AhNPEPHG8hDy%3Boo", "delivery":{ "tax":"0.00", "id":"1" }, "user":"Dmitry_DM", "id":"2", "mod_date":"1458687828", "uid":"1", "discount":{ "sum":"0.00" }, "cnt":"1", "hide":"0", "rem":"-----< 23.03.2016 02:03 >-----------------------------------
Пользователь Dmitry_DM оформил заказ

", "nom":"00002", "status":"0", "ip":"46.61.85.85", "currency":{ "rate":"1", "id":"1" }, "add_date":"1458687828", "payment":{ "topay":"51.00$", "id":"1" }, "profit":"51.00", "amount":"51.00", "fields":{ "1":"1111111", "2":"5555222" }, "akey":"3c3d7d3e3664f2aeb3af3a5c41da1e6e" } ], "per_page":"20", "order_uids":[ "1" ], "profit":"231.00", "pages_cnt":1, "order_fields":{ "1":{ "required":1, "expand":0, "name":"Контактный телефон", "dig":0, "pos":1, "type":"phone" }, "2":{ "required":1, "expand":0, "name":"Адрес доставки", "dig":0, "pos":2, "type":"textarea" } }, "total":551, "order_hide":{ "1":"В архиве", "0":"В работе", "2":"В корзине" }, "order_status":{ "8":"Завершён", "4":"Готов", "1":"Оплачивается", "3":"В обработке", "0":"Новый", "7":"Доставлен", "9":"Отменён", "2":"Оплачен", "5":"Доставляется" } } }
 

[GET] Определенный заказ




С помощью запроса можно осуществить получение определенного заказа

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция с данными. Секция содержит следующие поля:

  • order_id – ID заказа (номер заказа)
  • order_nom – отформатированный ID заказа (номер заказа)
  • order_goods – ORDER_GOODS - секция с информацией о товарах заказа
  • order_digital_goods – ORDER_DIGITAL_GOODS - секция с информацией о цифровых товарах заказа
  • order_data – ORDER_DATA - секция с данными по заказу

ORDER_GOODS - секция с товарами заказа. Секция содержит следующие поля:

  • goods_fields – секция с описанием полей товара
  • goods – ORDER_GOODS_LIST - секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в заказе

ORDER_GOODS_LIST - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей. Список полей зависит от настройки “Дополнительные поля формы заказа” на странице “Управление полями заказа” магазина. Каждая подсекция содержит следующие поля:

  • goods_id – ID товара *
  • name – значение поля “Наименование”
  • price – цена товара *
  • cnt – количество товара в заказе *
  • sum – стоимость товара с учетом его количества в заказе *
  • vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • warning – предупреждения по товару (например, если товара нет в наличие на момент оформления заказа) *
  • cat – секция с данными о категории товара. cat_id - ID категории. cat_name - название категории
  • img – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. photo - URL к полному изображению товара
  • art – значение поля “Артикул”
  • brand – значение поля “Производитель”
  • warr – значение поля “Гарантия”
  • weight – значение поля “Вес”
  • unit – значение поля “Единица”
  • options – выбранные опции товара
  • otherN – значение поля “Дополнительное поле N”. Количество дополнительных полей зависит от настроек магазина, но не может быть больше девяти
  • added_user – логин пользователя, добавившего товар

    • * Всегда присутствует, не зависимо от настройки “Отображение полей товара в заказе”

ORDER_DIGITAL_GOODS - секция с дополнительными данными по цифровым товарам заказа. Секция содержит следующие поля:

  • cnt – количество цифровых товаров в заказе
  • goods – ORDER_DIGITAL_GOODS_LIST - секция с дополнительными данными по цифровым товарам заказа. ID подсекции - порядковый номер в списке подсекций

ORDER_DIGITAL_GOODS_LIST - секция с дополнительными данными по цифровым товарам заказа. ID подсекции - порядковый номер в списке подсекций. Подсекция содержит следующие поля:

  • id – ID товара
  • name – название товара
  • brand – значение поля “Производитель”
  • art – значение поля “Артикул”
  • type – тип товара (1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
  • data – данные по товару (ссылка на файл, электронный код)
  • size – размер файла (если тип товара - “1 - товар-файл”)

ORDER_DATA - секция с данными по заказу. Секция содержит следующие поля:

  • order_hash – хэш id заказа для получения или изменения даны по заказу
  • order_cnt – количество товаров в заказе
  • order_weight – суммарный вес заказа
  • currency – валюта, в которой был оформлен заказ, где id - ID валюты, в которой был оформлен заказ, rate - курс валюты на момент оформления заказа
  • order_discount – информация о скидке по заказу
  • order_amount – cумарная стоимость товарных позиций в заказе
  • order_total – оборотная сумма заказа
  • order_topay – сумма к оплате выбранным способом с учётом дисконтной скидки
  • order_vat – НДС от суммы "К оплате" (order_topay)
  • order_profit – суммарная прибыль по заказ
  • order_status – статус заказа, где code - ID статуса, status - название статуса
  • order_payment – информация о способе оплаты заказа, где id - ID способа оплаты, name - название способа оплаты, descr - описание способа оплаты
  • order_delivery – информация о способе доставки заказа, где id - ID способа доставки, name - название способа доставки, descr - описание способа доставки, tax - такса за доставку заказа, delivery_time - дата доставки заказа, delivery_courier - курьер назначенный заказу
  • order_fields – секция со значениями дополнительных полей заказа. В подсекции fields_descr содержится подписи к полям заказа
  • order_add_date – дата добавления заказа
  • order_mod_date – дата последнего изменения заказа
  • order_ip – ip, с которого был сделан заказ
  • order_user – логин пользователя, оформившего заказ
  • order_uid – ID пользователя, оформившего заказ
  • order_group_uid – группа к которой относится пользователь, оформивший заказ
  • order_auth – auth-ключ для ссылки на страницу просмотра заказа
  • order_akey – ключ для формирования auth-ссылки на страницу просмотра заказа
  • order_journal – лог заказа
  • order_note – примечания к заказу
  • order_hide – группа, к которой относится заказ (0 - “В работе”, 1 - “В архиве”, 2 - “В корзине”)

ORDER_GOODS_OPTIONS - секция с данными опций товара. Секция содержит следующие поля:

  • selected_str – строка с выбранными опциями в формате "<OPTION_ID>-<ID_SELECTED_VALUE>-<ID_SELECTED_VALUE>:<OPTION_ID>-<ID_SELECTED_VALUE>:...," где OPTION_ID - ID опции, ID_SELECTED_VALUE - ID выбранного значения
  • selected_data – SELECTED_OPTIONS_DATA - секция с выбранными опциями товара
  • all_options_data – OPTIONS_DATA - секция со всеми опциями товара

SELECTED_OPTIONS_DATA - секция с выбранными опциями товара. Данная секция содержит список подсекций с данными опций товаров. ID подсекции - ID опции в магазине. Каждая подсекция содержит следующие поля:

  • name – название опции
  • indx – порядковый номер значения опции из списка значений, возвращаемый в параметре “all_options_data->values”
  • over – наценка по опции. Если наценка указана в виде процента, то данное поле будет содержать значение в формате “PERSENT&OVER”, например “4%&2.00”.

OPTIONS_DATA - секция со всеми опциями товара. Данная секция содержит список подсекций с данными опций товаров. ID подсекции - ID опции в магазине. Каждая подсекция содержит следующие поля:

  • name – название опции
  • values – секция со значениями товара. label - подпись к значению. val - наценка опции (если наценка задана в виде процента, то val содержит вычисленное значение наценки). percent - размер наценки в процентах (поле присутствует только для наценок, заданных в виде процента).
  • use_images – признак “Использовать изображения”
  • as_checkbox – признак “Выводить в виде чекбокса”
  • as_radio – признак “Выводить в виде "radio buttons"”
  • check_first – признак “Выделять первое значение в "radio buttons"”
  • pos – позиция опции в списке опций товара
GETSHOP /uapi/shop/order/?order=ORDER_HASH
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/order/', array( 'order'=>'ORDER_HASH' )); print_r($response); //Получаем ответ ?>
{ "success":{ "count":"2", "page":1, "orders":[ { "order_hash":"UqTzDXQDXQMV3yE2cfI5peQa9AhNPEPHG8hDy%3Boo", "delivery":{ "tax":"0.00", "id":"1" }, "user":"Dmitry_DM", "id":"2", "mod_date":"1458687828", "uid":"1", "discount":{ "sum":"0.00" }, "cnt":"1", "hide":"0", "rem":"-----< 23.03.2016 02:03 >-----------------------------------
Пользователь Dmitry_DM оформил заказ

", "nom":"00002", "status":"0", "ip":"46.61.85.85", "currency":{ "rate":"1", "id":"1" }, "add_date":"1458687828", "payment":{ "topay":"51.00$", "id":"1" }, "profit":"51.00", "amount":"51.00", "fields":{ "1":"1111111", "2":"5555222" }, "akey":"3c3d7d3e3664f2aeb3af3a5c41da1e6e" }, { "order_hash":"UqTzDXQDXQMW3yE2cfI5p4lur1zUPEiVskfgy%3Boo", "delivery":{ "tax":"0.00", "id":"3" }, "weight":"300", "user":"Dmitry_DM", "id":"1", "mod_date":"1458511535", "uid":"1", "discount":{ "sum":"0.00" }, "cnt":"1", "hide":"0", "rem":"-----< 21.03.2016 01:05 >-----------------------------------
Пользователь Dmitry_DM оформил заказ

", "nom":"00001", "status":"0", "ip":"178.204.152.179", "currency":{ "rate":"1", "id":"1" }, "add_date":"1458511535", "payment":{ "topay":"500.00$", "id":"2" }, "profit":"180.00", "amount":"500.00", "fields":{ "1":"312312312", "2":"312312312" }, "akey":"e4b52bf982e95c031584bdd61b43613f" } ], "per_page":"20", "order_uids":[ "1" ], "profit":"231.00", "pages_cnt":1, "order_fields":{ "1":{ "required":1, "expand":0, "name":"Контактный телефон", "dig":0, "pos":1, "type":"phone" }, "2":{ "required":1, "expand":0, "name":"Адрес доставки", "dig":0, "pos":2, "type":"textarea" } }, "total":551, "order_hide":{ "1":"В архиве", "0":"В работе", "2":"В корзине" }, "order_status":{ "8":"Завершён", "4":"Готов", "1":"Оплачивается", "3":"В обработке", "0":"Новый", "7":"Доставлен", "9":"Отменён", "2":"Оплачен", "5":"Доставляется" } } }
 

[POST] Добавить товар в заказ


  • order=ORDER_HASH – [Строка] - хэш заказа, по которому нужно модифицировать данные
  • id=GOODS_ID – [Число] - ID товара, который нужно добавить в заказ

В уже существующий заказ можно добавить новый товар

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция с данными. Секция содержит следующие поля:

  • order_id – ID заказа (номер заказа)
  • order_nom – отформатированный ID заказа (номер заказа)
  • order_goods – ORDER_GOODS - секция с информацией о товарах заказа
  • order_digital_goods – ORDER_DIGITAL_GOODS - секция с информацией о цифровых товарах заказа
  • order_data – ORDER_DATA - секция с данными по заказу

ORDER_GOODS - секция с товарами заказа. Секция содержит следующие поля:

  • goods_fields – секция с описанием полей товара
  • goods – ORDER_GOODS_LIST - секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в заказе

ORDER_GOODS_LIST - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей. Список полей зависит от настройки “Дополнительные поля формы заказа” на странице “Управление полями заказа” магазина. Каждая подсекция содержит следующие поля:

  • goods_id – ID товара *
  • name – значение поля “Наименование”
  • price – цена товара *
  • cnt – количество товара в заказе *
  • sum – стоимость товара с учетом его количества в заказе *
  • vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • warning – предупреждения по товару (например, если товара нет в наличие на момент оформления заказа) *
  • cat – секция с данными о категории товара. cat_id - ID категории. cat_name - название категории
  • img – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. photo - URL к полному изображению товара
  • art – значение поля “Артикул”
  • brand – значение поля “Производитель”
  • warr – значение поля “Гарантия”
  • weight – значение поля “Вес”
  • unit – значение поля “Единица”
  • options – выбранные опции товара
  • otherN – значение поля “Дополнительное поле N”. Количество дополнительных полей зависит от настроек магазина, но не может быть больше девяти
  • added_user – логин пользователя, добавившего товар

    • * Всегда присутствует, не зависимо от настройки “Отображение полей товара в заказе”

ORDER_DIGITAL_GOODS - секция с дополнительными данными по цифровым товарам заказа. Секция содержит следующие поля:

  • cnt – количество цифровых товаров в заказе
  • goods – ORDER_DIGITAL_GOODS_LIST - секция с дополнительными данными по цифровым товарам заказа. ID подсекции - порядковый номер в списке подсекций

ORDER_DIGITAL_GOODS_LIST - секция с дополнительными данными по цифровым товарам заказа. ID подсекции - порядковый номер в списке подсекций. Подсекция содержит следующие поля:

  • id – ID товара
  • name – название товара
  • brand – значение поля “Производитель”
  • art – значение поля “Артикул”
  • type – тип товара (1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
  • data – данные по товару (ссылка на файл, электронный код)
  • size – размер файла (если тип товара - “1 - товар-файл”)

ORDER_DATA - секция с данными по заказу. Секция содержит следующие поля:

  • order_hash – хэш id заказа для получения или изменения даны по заказу
  • order_cnt – количество товаров в заказе
  • order_weight – суммарный вес заказа
  • currency – валюта, в которой был оформлен заказ, где id - ID валюты, в которой был оформлен заказ, rate - курс валюты на момент оформления заказа
  • order_discount – информация о скидке по заказу
  • order_amount – cумарная стоимость товарных позиций в заказе
  • order_total – оборотная сумма заказа
  • order_topay – сумма к оплате выбранным способом с учётом дисконтной скидки
  • order_vat – НДС от суммы "К оплате" (order_topay)
  • order_profit – суммарная прибыль по заказ
  • order_status – статус заказа, где code - ID статуса, status - название статуса
  • order_payment – информация о способе оплаты заказа, где id - ID способа оплаты, name - название способа оплаты, descr - описание способа оплаты
  • order_delivery – информация о способе доставки заказа, где id - ID способа доставки, name - название способа доставки, descr - описание способа доставки, tax - такса за доставку заказа, delivery_time - дата доставки заказа, delivery_courier - курьер назначенный заказу
  • order_fields – секция со значениями дополнительных полей заказа. В подсекции fields_descr содержится подписи к полям заказа
  • order_add_date – дата добавления заказа
  • order_mod_date – дата последнего изменения заказа
  • order_ip – ip, с которого был сделан заказ
  • order_user – логин пользователя, оформившего заказ
  • order_uid – ID пользователя, оформившего заказ
  • order_group_uid – группа к которой относится пользователь, оформивший заказ
  • order_auth – auth-ключ для ссылки на страницу просмотра заказа
  • order_akey – ключ для формирования auth-ссылки на страницу просмотра заказа
  • order_journal – лог заказа
  • order_note – примечания к заказу
  • order_hide – группа, к которой относится заказ (0 - “В работе”, 1 - “В архиве”, 2 - “В корзине”)

ORDER_GOODS_OPTIONS - секция с данными опций товара. Секция содержит следующие поля:

  • selected_str – строка с выбранными опциями в формате "<OPTION_ID>-<ID_SELECTED_VALUE>-<ID_SELECTED_VALUE>:<OPTION_ID>-<ID_SELECTED_VALUE>:...," где OPTION_ID - ID опции, ID_SELECTED_VALUE - ID выбранного значения
  • selected_data – SELECTED_OPTIONS_DATA - секция с выбранными опциями товара
  • all_options_data – OPTIONS_DATA - секция со всеми опциями товара

SELECTED_OPTIONS_DATA - секция с выбранными опциями товара. Данная секция содержит список подсекций с данными опций товаров. ID подсекции - ID опции в магазине. Каждая подсекция содержит следующие поля:

  • name – название опции
  • indx – порядковый номер значения опции из списка значений, возвращаемый в параметре “all_options_data->values”
  • over – наценка по опции. Если наценка указана в виде процента, то данное поле будет содержать значение в формате “PERSENT&OVER”, например “4%&2.00”.

OPTIONS_DATA - секция со всеми опциями товара. Данная секция содержит список подсекций с данными опций товаров. ID подсекции - ID опции в магазине. Каждая подсекция содержит следующие поля:

  • name – название опции
  • values – секция со значениями товара. label - подпись к значению. val - наценка опции (если наценка задана в виде процента, то val содержит вычисленное значение наценки). percent - размер наценки в процентах (поле присутствует только для наценок, заданных в виде процента).
  • use_images – признак “Использовать изображения”
  • as_checkbox – признак “Выводить в виде чекбокса”
  • as_radio – признак “Выводить в виде "radio buttons"”
  • check_first – признак “Выделять первое значение в "radio buttons"”
  • pos – позиция опции в списке опций товара
POSTSHOP /uapi/shop/order/?order=ORDER_HASH&id=GOODS_ID
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->post('/shop/order/', array( 'order'=>'ORDER_HASH', 'id'=>'GOODS_ID' )); print_r($response); //Получаем ответ ?>
{ "success":{ "order_nom":"00001", "order_goods":{ "goods_fields":{ "other3":"Дополнительное поле 3", "vat":"НДС", "other1":"Дополнительное поле 1", "brand":"Производитель", "img":"Фото", "cat":"Категория", "weight":"Вес", "sum":"Сумма", "price_in":"Входящая", "art":"Артикул", "name":"Наименование", "other2":"Дополнительное поле 2", "cnt":"Кол-во", "warr":"Гарантия", "added_user":"Владелец", "unit":"Единица", "price":"Цена" }, "goods":{ "5":{ "other3":"ЗУ в комплект не входит", "vat":"", "other1":"20x20x20", "brand":"Transcend", "img":{ "small":"http://yoursite.ucoz.ru/_sh/00/5s.jpg", "photo":"http://yoursite.ucoz.ru/_sh/00/5.jpg" }, "cat":"Спорт", "weight":{ "weight":"300.00", "weight_raw":300 }, "sum":{ "sum_raw":500, "sum":"500.00$" }, "price_in":{ "price_raw":"320.00", "price":"320.00$" }, "art":"32165468-6898", "name":"Новые очки от Recon Transcend", "other2":"Не бьются", "goods_url":{ "hgu":"sport-glasses", "shop_url":"http://yoursite.ucoz.ru/shop/5/desc/sport-glasses" }, "cnt":"1", "warr":"12мес", "goods_id":"5", "added_user":"Tom", "unit":"Размер", "price":{ "price_raw":500, "price":"500.00$" } } } }, "order_digital_goods":{ "goods":[ ], "cnt":0 }, "order_id":"1", "order_data":{ "order_delivery":{ "courier":"", "delivery_date":"0", "name":"Способ доставки № 3", "tax":{ "tax_raw":0, "tax":0 }, "id":"3", "descr":"Описание способа доставки" }, "order_profit":{ "profit_raw":"180.00", "profit":"180.00$" }, "order_user":"Dmitry_DM", "order_currency":{ "rate":"1", "id":"1" }, "order_hash":"UqTzDXQDXQMW3yE2cfI5p4lur1zUPEiVskfgy%3Boo", "order_note":"", "order_ip":"178.204.152.179", "order_add_date":"1458511535", "order_fields":{ "1":"312312312", "fields_descr":{ "1":"Контактный телефон", "2":"Адрес доставки" }, "2":"312312312" }, "order_hide":"0", "order_mod_date":"1458511535", "order_auth":"", "order_uid":"1", "order_weight":{ "weight":"300.00", "weight_raw":300 }, "order_akey":"e4b52bf982e95c031584bdd61b43613f", "order_amount":{ "amount_raw":500, "amount":"500.00$" }, "order_vat":{ "vat_raw":0, "vat_type":"0", "vat":0 }, "order_cnt":"1", "order_total":{ "total_raw":500, "total":"500.00$" }, "order_topay":{ "topay":"500.00$", "topay_curr":"500.00$", "topay_raw":500 }, "order_journal":"-----< 21.03.2016 01:05 >-----------------------------------
Пользователь Dmitry_DM оформил заказ

", "order_payment":{ "name":"Способ оплаты № 2", "id":"2", "descr":"Описание способа оплаты" }, "order_group_uid":"4", "order_status":{ "status":"Новый", "code":"0" }, "order_discount":{ "promo_code":"", "promo_group":"", "discount_raw":0, "discount":0 } } } }
 

[PUT] Назначение группы заказу


  • ids=ID_LIST – [Строка] – ID заказа(ов), через запятую, для которых нужно назначить группу

С помощью запроса можно назначить группы заказу

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ "msg":"Заказ(ы) перенесены ..." } }

Дополнительные параметры запроса

  • hide=ORDER_GROUP – [Число] – группа заказа, которую нужно назначить. Если параметр не указан, то заказу(ам) будет назначена группа “0 - “В работе””
    !!! Список всех групп можно получить с помощью отдельного запроса - см. раздел “Получение списка групп заказа”
    Возможные значения:
    0 - “В работе”
    1 - “В архиве”
    2 - “В корзине”
PUTSHOP /uapi/shop/invoices/?mode=hide&ids=ID_LIST
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/shop/invoices/', array( 'mode'=>'hide', 'ids'=>'ID_LIST' )); print_r($response); //Получаем ответ ?>
{ "success":{ "msg":"Заказ(ы) перенесены ..." } }
 

[PUT] Назначение курьера заказу


  • ids=ID_LIST – [Строка] – ID заказа(ов), через запятую, для которых нужно назначить статус
  • group_courier=COURIER – [Строка] – логин пользователя, которого нужно назначить курьером для заказа(ов)

С помощью запроса можно назначить группы заказу

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ "msg":"~Для заказа(ов) ... курьер ... установлен" } }
PUTSHOP /uapi/shop/invoices/?mode=setCourier&ids=ID_LIST&group_courier=COURIER
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/shop/invoices/', array( 'mode'=>'setCourier', 'ids'=>'ID_LIST', 'group_courier'=>'COURIER', )); print_r($response); //Получаем ответ ?>
{ "success":{ "msg":"Для заказа(ов) ... статус ... установлен" } }
 

[PUT] Модификация состава заказа


  • order=ORDER_HASH – [Строка] - хэш заказа, по которому нужно модифицировать данные

Дополнительные параметры запроса

  • cnt_REC_ID=GOODS_CNT – [Число] - количество единиц товара. REC_ID - ID записи товарной позиции в заказе
  • price_REC_ID=NEW_PRICE – [Число] - новая цена товара. REC_ID - ID записи товарной позиции в заказе
  • del_REC_ID=1 – [Число] - признак удаления единицы товара из заказа. REC_ID - ID записи товарной позиции в заказе

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция с данными. Секция содержит следующие поля:

  • order_id – ID заказа (номер заказа)
  • order_nom – отформатированный ID заказа (номер заказа)
  • order_goods – ORDER_GOODS - секция с информацией о товарах заказа
  • order_digital_goods – ORDER_DIGITAL_GOODS - секция с информацией о цифровых товарах заказа
  • order_data – ORDER_DATA - секция с данными по заказу

ORDER_GOODS - секция с товарами заказа. Секция содержит следующие поля:

  • goods_fields – секция с описанием полей товара
  • goods – ORDER_GOODS_LIST - секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в заказе

ORDER_GOODS_LIST - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей. Список полей зависит от настройки “Дополнительные поля формы заказа” на странице “Управление полями заказа” магазина. Каждая подсекция содержит следующие поля:

  • goods_id – ID товара *
  • name – значение поля “Наименование”
  • price – цена товара *
  • cnt – количество товара в заказе *
  • sum – стоимость товара с учетом его количества в заказе *
  • vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • warning – предупреждения по товару (например, если товара нет в наличие на момент оформления заказа) *
  • cat – секция с данными о категории товара. cat_id - ID категории. cat_name - название категории
  • img – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. photo - URL к полному изображению товара
  • art – значение поля “Артикул”
  • brand – значение поля “Производитель”
  • warr – значение поля “Гарантия”
  • weight – значение поля “Вес”
  • unit – значение поля “Единица”
  • options – выбранные опции товара
  • otherN – значение поля “Дополнительное поле N”. Количество дополнительных полей зависит от настроек магазина, но не может быть больше девяти
  • added_user – логин пользователя, добавившего товар

    • * Всегда присутствует, не зависимо от настройки “Отображение полей товара в заказе”

ORDER_DIGITAL_GOODS - секция с дополнительными данными по цифровым товарам заказа. Секция содержит следующие поля:

  • cnt – количество цифровых товаров в заказе
  • goods – ORDER_DIGITAL_GOODS_LIST - секция с дополнительными данными по цифровым товарам заказа. ID подсекции - порядковый номер в списке подсекций

ORDER_DIGITAL_GOODS_LIST - секция с дополнительными данными по цифровым товарам заказа. ID подсекции - порядковый номер в списке подсекций. Подсекция содержит следующие поля:

  • id – ID товара
  • name – название товара
  • brand – значение поля “Производитель”
  • art – значение поля “Артикул”
  • type – тип товара (1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
  • data – данные по товару (ссылка на файл, электронный код)
  • size – размер файла (если тип товара - “1 - товар-файл”)

ORDER_DATA - секция с данными по заказу. Секция содержит следующие поля:

  • order_hash – хэш id заказа для получения или изменения даны по заказу
  • order_cnt – количество товаров в заказе
  • order_weight – суммарный вес заказа
  • currency – валюта, в которой был оформлен заказ, где id - ID валюты, в которой был оформлен заказ, rate - курс валюты на момент оформления заказа
  • order_discount – информация о скидке по заказу
  • order_amount – cумарная стоимость товарных позиций в заказе
  • order_total – оборотная сумма заказа
  • order_topay – сумма к оплате выбранным способом с учётом дисконтной скидки
  • order_vat – НДС от суммы "К оплате" (order_topay)
  • order_profit – суммарная прибыль по заказ
  • order_status – статус заказа, где code - ID статуса, status - название статуса
  • order_payment – информация о способе оплаты заказа, где id - ID способа оплаты, name - название способа оплаты, descr - описание способа оплаты
  • order_delivery – информация о способе доставки заказа, где id - ID способа доставки, name - название способа доставки, descr - описание способа доставки, tax - такса за доставку заказа, delivery_time - дата доставки заказа, delivery_courier - курьер назначенный заказу
  • order_fields – секция со значениями дополнительных полей заказа. В подсекции fields_descr содержится подписи к полям заказа
  • order_add_date – дата добавления заказа
  • order_mod_date – дата последнего изменения заказа
  • order_ip – ip, с которого был сделан заказ
  • order_user – логин пользователя, оформившего заказ
  • order_uid – ID пользователя, оформившего заказ
  • order_group_uid – группа к которой относится пользователь, оформивший заказ
  • order_auth – auth-ключ для ссылки на страницу просмотра заказа
  • order_akey – ключ для формирования auth-ссылки на страницу просмотра заказа
  • order_journal – лог заказа
  • order_note – примечания к заказу
  • order_hide – группа, к которой относится заказ (0 - “В работе”, 1 - “В архиве”, 2 - “В корзине”)
PUTSHOP /uapi/shop/order/?order=ORDER_HASH&cnt_REC_ID=GOODS_CNT
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/shop/order/', array( 'order' => 'UqRgN7O%3B1ElzSZVqyJA4IFXbSG3s8iq3jvd2y%3Boo', 'cnt_3' => 10, )); print_r($response); //Получаем ответ ?>
{ "success":{ "order_data": { "order_add_date": "1336103454", "order_akey": "78f33ec011ee8e0d620fc31cc836d4ef", "order_amount": { "amount": "2445.00 руб.", "amount_raw": 2445 }, "order_auth": "", "order_cnt": "11", "order_currency": { "id": "2", "rate": "1" }, "order_delivery": { "courier": "", "delivery_date": "", "descr": "Товар вы можете получить по прибытию в наш магазин", "id": "1", "name": "Самовывоз", "tax": { "tax": "350.00 руб.", "tax_raw": 350 } }, "order_discount": { "discount": 0, "discount_raw": 0, "promo_code": "", "promo_group": "" }, "order_fields": { "1": "89111111111", "2": "test_api_change", "3": "Зубков Сергей Владимирович", "fields_descr": { "1": "Контактный телефон", "2": "Адрес доставки", "3": "ФИО" } }, "order_group_name": "Гости", "order_group_uid": "999", "order_hash": "UqRgN7O%3B1ElzSZVqyJA4IFXbSG3s8iq3jvd2y%3Boo", "order_hide": "2", "order_ip": "176.59.221.229", "order_journal": "-----< 16.09.2020 01:14 >-----------------------------------
dmitriy_komissarenko перенёс заказ В корзину

-----< 23.10.2012 16:12:45 >--------------- --------------------
Администратор перенёс заказ В архив

-----< 04.05.2012 07:50:54 >-----------------------------------
Пользователь оформил заказ

", "order_mod_date": "1601551769", "order_note": "", "order_payment": { "descr": "Рассчитаться возможно при получении товара", "id": "1", "name": "Наличными при получении" }, "order_profit": { "profit": "0.00 руб.", "profit_raw": "0" }, "order_status": { "code": "0", "status": "Новый" }, "order_topay": { "topay": "2795.00 руб.", "topay_curr": "2795.00 руб.", "topay_raw": 2795 }, "order_total": { "total": "2795.00 руб.", "total_raw": 2795 }, "order_uid": "0", "order_user": "", "order_vat": { "vat": 0, "vat_raw": 0, "vat_type": "0" }, "order_weight": { "weight": "0.00", "weight_raw": 0 } }, "order_digital_goods": { "cnt": 0, "goods": [] }, "order_goods": { "goods": { "3": { "cnt": "10", "goods_id": "3", "goods_url": { "hgu": null, "shop_url": "" }, "name": "Влагоотделитель, 1/4\" MATRIX 57008", "price": { "price": "183.50 руб.", "price_raw": 183.5 }, "price_in": { "price": "183.50 руб.", "price_raw": "183.50" }, "sum": { "sum": "1835.00 руб.", "sum_raw": 1835 } }, "486": { "cnt": "1", "goods_id": "105393", "goods_url": { "hgu": "shakhmaty-n08824", "shop_url": "http://yoursite.ucoz.ru/shop/105393/desc/shakhmaty-n08824" }, "name": "Шахматы Н08824", "price": { "price": "610.00 руб.", "price_raw": 610 }, "price_in": { "price": "610.00 руб.", "price_raw": "610.00" }, "sum": { "sum": "610.00 руб.", "sum_raw": 610 } } }, "goods_fields": { "cnt": "Кол-во", "name": "Наименование", "price": "Цена", "price_in": "Входящая", "sum": "Сумма" } }, "order_id": "1", "order_nom": "00001" } }
 

[PUT] Модификация полей заказа


  • mode=inv_chfld_save – [Строка] - действие, которое нужно выполнить - изменить поле заказа
  • order=ORDER_HASH – [Строка] - хэш заказа, по которому нужно модифицировать данные
  • fid=FIELD_ID – [Число] - номер поля заказа, значение которого нужно изменить. Полный список полей заказа можно получить с помощью GET-запроса “Получение списка полей заказа” !!! Через API можно изменять поля всех типов кроме типа “file”
  • fval=FIELD_VALUE – [Строка] - значение, которое нужно установить для поля. Для типа поля “checkbox” значение должно быть “1” или “0”.

Дополнительные параметры запроса

  • gmap_a=ADDRESS – [Строка] - адрес для поля типа “gmaps”
  • gmap_s=LAT_VALUE – [Строка] - значение lat координаты для поля типа “gmaps” в формате “49.431347032415715”
  • gmap_d=LONG_VALUE – [Строка] - значение long координаты для поля типа “gmaps” в формате “32.09275390624998”

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция с данными. Секция содержит следующие поля:

  • order_id – ID заказа (номер заказа)
  • order_nom – отформатированный ID заказа (номер заказа)
  • order_goods – ORDER_GOODS - секция с информацией о товарах заказа
  • order_digital_goods – ORDER_DIGITAL_GOODS - секция с информацией о цифровых товарах заказа
  • order_data – ORDER_DATA - секция с данными по заказу

ORDER_GOODS - секция с товарами заказа. Секция содержит следующие поля:

  • goods_fields – секция с описанием полей товара
  • goods – ORDER_GOODS_LIST - секция со списком товаров заказа. ID подсекции - ID записи товарной позиции в заказе

ORDER_GOODS_LIST - секция с описанием дополнительных полей заказа. ID подсекции - порядковый номер поля в списке полей. Список полей зависит от настройки “Дополнительные поля формы заказа” на странице “Управление полями заказа” магазина. Каждая подсекция содержит следующие поля:

  • goods_id – ID товара *
  • name – значение поля “Наименование”
  • price – цена товара *
  • cnt – количество товара в заказе *
  • sum – стоимость товара с учетом его количества в заказе *
  • vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • warning – предупреждения по товару (например, если товара нет в наличие на момент оформления заказа) *
  • cat – секция с данными о категории товара. cat_id - ID категории. cat_name - название категории
  • img – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. photo - URL к полному изображению товара
  • art – значение поля “Артикул”
  • brand – значение поля “Производитель”
  • warr – значение поля “Гарантия”
  • weight – значение поля “Вес”
  • unit – значение поля “Единица”
  • options – выбранные опции товара
  • otherN – значение поля “Дополнительное поле N”. Количество дополнительных полей зависит от настроек магазина, но не может быть больше девяти
  • added_user – логин пользователя, добавившего товар

    • * Всегда присутствует, не зависимо от настройки “Отображение полей товара в заказе”

ORDER_DIGITAL_GOODS - секция с дополнительными данными по цифровым товарам заказа. Секция содержит следующие поля:

  • cnt – количество цифровых товаров в заказе
  • goods – ORDER_DIGITAL_GOODS_LIST - секция с дополнительными данными по цифровым товарам заказа. ID подсекции - порядковый номер в списке подсекций

ORDER_DIGITAL_GOODS_LIST - секция с дополнительными данными по цифровым товарам заказа. ID подсекции - порядковый номер в списке подсекций. Подсекция содержит следующие поля:

  • id – ID товара
  • name – название товара
  • brand – значение поля “Производитель”
  • art – значение поля “Артикул”
  • type – тип товара (1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
  • data – данные по товару (ссылка на файл, электронный код)
  • size – размер файла (если тип товара - “1 - товар-файл”)

ORDER_DATA - секция с данными по заказу. Секция содержит следующие поля:

  • order_hash – хэш id заказа для получения или изменения даны по заказу
  • order_cnt – количество товаров в заказе
  • order_weight – суммарный вес заказа
  • currency – валюта, в которой был оформлен заказ, где id - ID валюты, в которой был оформлен заказ, rate - курс валюты на момент оформления заказа
  • order_discount – информация о скидке по заказу
  • order_amount – cумарная стоимость товарных позиций в заказе
  • order_total – оборотная сумма заказа
  • order_topay – сумма к оплате выбранным способом с учётом дисконтной скидки
  • order_vat – НДС от суммы "К оплате" (order_topay)
  • order_profit – суммарная прибыль по заказ
  • order_status – статус заказа, где code - ID статуса, status - название статуса
  • order_payment – информация о способе оплаты заказа, где id - ID способа оплаты, name - название способа оплаты, descr - описание способа оплаты
  • order_delivery – информация о способе доставки заказа, где id - ID способа доставки, name - название способа доставки, descr - описание способа доставки, tax - такса за доставку заказа, delivery_time - дата доставки заказа, delivery_courier - курьер назначенный заказу
  • order_fields – секция со значениями дополнительных полей заказа. В подсекции fields_descr содержится подписи к полям заказа
  • order_add_date – дата добавления заказа
  • order_mod_date – дата последнего изменения заказа
  • order_ip – ip, с которого был сделан заказ
  • order_user – логин пользователя, оформившего заказ
  • order_uid – ID пользователя, оформившего заказ
  • order_group_uid – группа к которой относится пользователь, оформивший заказ
  • order_auth – auth-ключ для ссылки на страницу просмотра заказа
  • order_akey – ключ для формирования auth-ссылки на страницу просмотра заказа
  • order_journal – лог заказа
  • order_note – примечания к заказу
  • order_hide – группа, к которой относится заказ (0 - “В работе”, 1 - “В архиве”, 2 - “В корзине”)
PUTSHOP /uapi/shop/checkout/?order=ORDER_HASH&mode=inv_chfld_save&fval=test_api_change&fid=2
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/shop/invoices/', array( 'order' => 'UqRgN7O%3B1ElzWc9Oy1Ata9hLSGzgcNVN25iA3Mko', 'mode' => 'inv_chfld_save', 'fid' => 2, 'fval' => 'test_api_change', )); print_r($response); //Получаем ответ ?>
{ "success":{ "order_data": { "order_add_date": "1358864881", "order_akey": "4430da8174b6f70bb48a77828d7b0b07", "order_amount": { "amount": "1690.00 руб.", "amount_raw": 1690 }, "order_auth": "", "order_cnt": "10", "order_currency": { "id": "2", "rate": "1" }, "order_delivery": { "courier": "", "delivery_date": "", "descr": "Доставка товара до подъезда с согласованием с вами времени доставки. Обращаем ваше внимание на то, что стоимость доставки может измениться в зависимости от расстоя ния от нашего магазина до вас. (Только по городу Бор)", "id": "2", "name": "Платная доставка", "tax": { "tax": 0, "tax_raw": 0 } }, "order_discount": { "discount": 0, "discount_raw": 0, "promo_code": "", "promo_group": "" }, "order_fields": { "1": "89175525353", "2": "test_api_change", "3": "Ананьев Дмитрий Вячеславович", "fields_descr": { "1": "Контактный телефон", "2": "Адрес доставки", "3": "ФИО" } }, "order_group_name": "Гости", "order_group_uid": "999", "order_hash": "UqRgN7O%3B1ElzWc9Oy1Ata9hLSGzgcNVN25iA3Mko", "order_hide": "0", "order_ip": "46.73.44.5", "order_journal": "-----< 16.09.2020 01:12 >-----------------------------------
dmitriy_komissarenko изменил статус: Новый => Завершён

-----< 22.01.2013 18:28:01 >----- ------------------------------
Пользователь оформил заказ

", "order_mod_date": "1601551085", "order_note": "", "order_payment": { "descr": "Рассчитаться возможно при получении товара", "id": "1", "name": "Наличными при получении" }, "order_profit": { "profit": "0.00 руб.", "profit_raw": "0.00" }, "order_status": { "code": "8", "status": "Завершён" }, "order_topay": { "topay": "1690.00 руб.", "topay_curr": "1690.00 руб.", "topay_raw": 1690 }, "order_total": { "total": "1690.00 руб.", "total_raw": 1690 }, "order_uid": "0", "order_user": "", "order_vat": { "vat": 0, "vat_raw": 0, "vat_type": "0" }, "order_weight": { "weight": "0.00", "weight_raw": 0 } }, "order_digital_goods": { "cnt": 0, "goods": [] }, "order_goods": { "goods": { "15": { "cnt": "10", "goods_id": "9914", "goods_url": { "hgu": null, "shop_url": "" }, "name": "Набор cверел п/мет. 20шт HSS \"микро\" набор 36360", "price": { "price": "169.00 руб.", "price_raw": 169 }, "price_in": { "price": "169.00 руб.", "price_raw": "169.00" }, "sum": { "sum": "1690.00 руб.", "sum_raw": 1690 } } }, "goods_fields": { "cnt": "Кол-во", "name": "Наименование", "price": "Цена", "price_in": "Входящая", "sum": "Сумма" } }, "order_id": "11", "order_nom": "00011" } }
 

[PUT] Назначение статуса заказу


  • mode=status – [Строка] - указывает тип запроса - назначение статуса заказу
  • ids=ID_LIST – [Строка] - ID заказа(ов), через запятую, для которых нужно назначить статус

Дополнительные параметры запроса

  • status=ORDER_SSTATUS – [Число] - статус заказа, который нужно назначить. !!! Если параметр не указан, то заказу(ам) будет назначена группа “0 - “Новый””
    Возможные значения:
    0 - Новый
    1 - Оплачивается
    2 - Оплачен
    3 - В обработке
    4 - Готов
    5 - Доставляется
    7 - Доставлен
    8 - Завершён
    9 - Отменён
    !!! Список всех статусов заказа можно получить с помощью отдельного запроса - см. раздел “Получение списка статусов заказа”

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ "msg": "Для заказа(ов) ... статус ... установлен" } }
PUTSHOP /uapi/shop/invoices/?mode=status&ids=ID_LIST&status=4
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/shop/invoices/', array( 'mode' => 'status', 'ids' => '1, 2, 4', 'status' => '4', )); print_r($response); //Получаем ответ ?>
{ "success":{ "msg": "Для заказа(ов) 1, 2, 4 статус \"Готов\" установлен" } }
 

[GET] Получение списка брошенных корзин


Дополнительные параметры запроса

  • page=PAGE_ID – [Число] - номер текущей страницы выборки (значение по умолчанию - 1)
  • per_page=NUM – [Число] - количество корзин на страницу выборки (максимальное значение и значение по умолчанию - 20)
  • f_users_ids=USERS_IDS – [Строка] - список ID пользователей, через запятую, которым принадлежат брошенные корзины
  • f_user_login=BASE64_USER_LOGIN – [Строка] - логин пользователя (значение должно быть в Base64), которому принадлежит брошенная корзина. Можно указывать как точный логин пользователя так и маску для поиска. В маске можно использовать символы: * - любое количество символов в имени, ? - один любой символ. Например, запрос “ad*”; найдет все имена, начинающиеся с ad: admin, administrator, admin007 и т.д.
  • f_user_group=USERS_GROUP – [Число] - ID группы пользователей которым принадлежат брошенные корзины
  • f_goods_ids=GOODS_IDS – [Строка] - список ID товаров, через запятую, входящих в состав брошенных корзин пользователей
  • f_goods_count_mode=MODE – [Строка] - указывает режим фильтрации по суммарному количеству товаров в корзине.
    !!! Должен использоваться вместе с параметром f_goods_count, иначе будет проигнорирован. Возможные значения:
    'eq' - равно;
    'neq' - не равно;
    'gr' - больше;
    'greq' - больше или равно;
    'les' - меньше;
    'leq' - меньше или равно;
    'btw' - от...до (включая границы);
    'nin' - ...до и от… (не включая границы);
    При выборе параметра 'от...до' или '...до и от...' нужно указать нижний и верхний пределы через пробел. Иначе указываем только одно число.
  • f_goods_count=GOODS_COUNT – [Строка] - фильтр по суммарному количеству товаров в корзине. !!! Должен использоваться вместе с параметром f_goods_count_mode, иначе будет проигнорирован.
  • f_price_mode=MODE – [Строка] - указывает режим фильтрации по сумме брошенных корзин. !!! Должен использоваться вместе с параметром f_price, иначе будет проигнорирован. Возможные значения:
    'eq' - равно;
    'neq' - не равно;
    'gr' - больше;
    'greq' - больше или равно;
    'les' - меньше;
    'leq' - меньше или равно;
    'btw' - от...до;
    'nin' - ...до и от...;
    При выборе параметра 'от...до' или '...до и от...' нужно указать нижний и верхний пределы через пробел. Иначе указываем только одно число.
  • f_price=PRICE – [Строка] - фильтр по сумме брошенных корзин. !!! Должен использоваться вместе с параметром f_price_mode, иначе будет проигнорирован.
  • f_date=DATES – [Строка] - фильтр по дате последнего входа пользователя на сайт - период в формате "date1|date2". Будут отобраны брошенные корзины, пользователи которых входили на сайт в указанный период. Если не будет указана дата date1, то вместо нее будет использоваться значение “2000-01-01”. Если не будет указана дата date2, то вместо нее будет использоваться значение “2100-12-31”. Значение параметра “|” будет проигнорировано. !!! date1 и date2 должны соответствовать формату “YYYY-MM-DD HH:MI:SS”, где YYYY - год, MM - месяц, DD - день, HH - часы, MI - минуты, SS - секунды. Время является необязательной частью.

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция с данными. Секция содержит следующие поля:

  • users_baskets – USERS_BASKETS - секция с данными о брошенных корзинах пользователей. Данная секция содержит список подсекций с данными по каждому заказу. ID подсекции - ID пользователя, которому принадлежит брошенная корзина
  • paginator_pages_cnt – количество страниц выборки.
  • paginator_page – номер текущей страницы выборки.
  • paginator_count – суммарное количество секций.
  • paginator_per_page – количество секций на странице выборки.

USERS_BASKETS - секция с данными о брошенных корзинах пользователей. Данная секция содержит следующие поля:

  • user_id – ID пользователя, которому принадлежит корзина
  • user_login – логин пользователя, которому принадлежит корзина
  • user_group_id – ID группы пользователя, которому принадлежит корзина
  • user_group_name – название группы пользователя, которому принадлежит корзина
  • user_name – Ф.И.О пользователя, которому принадлежит корзина
  • user_email – E-Mail пользователя, которому принадлежит корзина
  • user_phone – телефон пользователя, которому принадлежит корзина (если такой указан в профиле пользователя)
  • user_last_activity – дата последнего входа на сайт пользователя, которому принадлежит корзина
  • user_ip – IP с которого был выполнен вход на сайт пользователем, которому принадлежит корзина
  • user_basket_amount – сумма корзины
  • user_basket_items_cnt – количество товаров в корзине
  • user_basket_items – BASKET_ITEMS - секция с данными о товарах корзины. ID подсекции - внутренний ID товара в корзине.

BASKET_ITEMS - секция с данными о товарах корзины. Данная секция содержит следующие поля:

  • goods_id – ID товара
  • name – значение поля “Наименование”
  • price – цена единицы товара с наценкой
  • cnt – количество товара в корзине
  • sum – стоимость товара с учетом его количества в корзине

    • !!! Также могут присутствовать и другие поля, в зависимости от настроек отображения полей заказа в магазине

GETSHOP /uapi/shop/usersbasket/
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/usersbasket/', array( )); print_r($response); //Получаем ответ ?>
{ "success":{ "paginator_page": 1, "paginator_pages_cnt": 1, "users_baskets": { "8": { "user_last_activity": "1599690384", "user_ip": "193.109.246.211", "user_group_name": "Пользователи1", "user_login": "ucozt0222", "user_basket_items": { "60": { "name": "Akai LTA-32N680HCP", "cnt": "1", "price": "110.00", "goods_id": "8", "sum": "110.00" }, "61": { "goods_id": "7", "price": "100.00", "sum": "100.00", "cnt": "1", "name": "LCD телевизор LG 19LG3060" } }, "user_basket_amount": "210.00", "user_email": "ucozt02222@gmail.com", "user_phone": "", "user_id": "8", "user_basket_items_cnt": 2, "user_name": "test ucoz", "user_group_id": "1" }, "6": { "user_group_id": "4", "user_name": "тест", "user_basket_items_cnt": 2, "user_id": "6", "user_phone": "", "user_email": "test@test.ru", "user_basket_amount": "52.00", "user_basket_items": { "245": { "name": "Евгений Онегин", "cnt": "1", "price": "1.00", "goods_id": "11", "sum": "1.00" }, "244": { "cnt": "1", "name": "Леггинсы с принтом мышечного строения тела (Размер: L)", "goods_id": "9", "price": "51.00", "sum": "51.00" } }, "user_login": "testtest", "user_group_name": "Администраторы", "user_ip": "109.122.62.126", "user_last_activity": "1601549277" }, }, "paginator_per_page": 20, "paginator_count": 3 } }
 

[GET] Получение списка способов доставки


  • page=deliverymethods – [Строка] - указывает, что нужно получить список способов доставки

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция со списком способов оплаты. Данная секция содержит список подсекций с данными по каждому способу доставки. ID подсекции - ID способа доставки в магазине. Каждая подсекция содержит следующие поля:

  • name – название способа доставки
  • dscr – описание способа доставки
  • pos – номер позиции в списке способов доставки
  • courier – признак, что для данного способа доставки возможна курьерская доставка.
GETSHOP /uapi/shop/getshopdata/?page=deliverymethods
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/getshopdata/', array( 'page' => 'deliverymethods', )); print_r($response); //Получаем ответ ?>
{ "success":{ "1": { "name": "Самовывоз", "dscr": "Товар вы можете получить по прибытию в наш офис", "courier": null, "pos": 1 } } }
 

[GET] Получение списка способов оплаты


  • page=paymentsmethods – [Строка] - указывает, что нужно получить список способов оплаты

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция со списком способов оплаты. Данная секция содержит список подсекций с данными по каждому способу оплаты. ID подсекции - ID способа оплаты в магазине. Каждая подсекция содержит следующие поля:

  • name – название способа оплаты
  • dscr – описание способа оплаты
  • pos – номер позиции в списке способов оплат
  • delivery_assoc – секция с данными о связях способа оплаты со способами доставки. В секции запись с ключем “all” указывает связан ли способ оплаты со всеми способами доставки (значение 1) или только с некоторыми (значение 0). ID каждой записи - ID способа доставки. Значение каждой записи указывает связан ли (значение 1) или нет (значение 0) способ оплаты с данным способом доставки.
GETSHOP /uapi/shop/getshopdata/?page=paymentsmethods
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/getshopdata/', array( 'page' => 'paymentsmethods', )); print_r($response); //Получаем ответ ?>
{ "success":{ "2": { "name": "unitpay", "delivery_assoc": { "all": 1 }, "dscr": "Оплата посредством Unitpay", "pos": 2 }, "1": { "delivery_assoc": { "all": 1 }, "name": "Наличными при получении", "dscr": "Рассчитаться можно с курьером наличными при получении товара", "pos": 1 } } }
 

[GET] Получение списка статусов заказа


  • page=order_status_list – [Строка] - указывает, что нужно получить список статусов заказов

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - где DATA - секция со списком статусов заказов. ID записи - ID статуса заказа в магазине. Значение записи - название статуса заказа в текущей локализации сайта.

GETSHOP /uapi/shop/getshopdata/?page=order_status_list
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/getshopdata/', array( 'page' => 'order_status_list', )); print_r($response); //Получаем ответ ?>
{ "success":{ "2": "Оплачен", "8": "Завершён", "1": "Оплачивается", "10": "Обработка оплаты", "0": "Новый", "3": "В обработке", "6": "Доставлен в пункт самовывоза", "9": "Отменён", "4": "Готов", "5": "Доставляется", "7": "Доставлен" } }
 

[GET] Получение списка групп заказа


  • page=order_hide_list – [Строка] - указывает, что нужно получить список групп заказа

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция со списком групп заказа. ID записи - ID группы заказа в магазине. Значение записи - название группы заказа в текущей локализации сайта.

GETSHOP /uapi/shop/getshopdata/?page=order_hide_list
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/getshopdata/', array( 'page' => 'order_hide_list', )); print_r($response); //Получаем ответ ?>
{ "success":{ "0": "В работе", "1": "В архиве", "2": "В корзине" } }
 

[GET] Получение списка полей заказа


  • page=order_fields_list – [Строка] - указывает, что нужно получить список полей заказа

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция со списком полей заказа. Данная секция содержит список подсекций с данными по каждому полю заказа. ID подсекции - порядковый номер поля в списке полей. Каждая подсекция содержит следующие поля:

  • name – название поля
  • type – тип поля (text, textarea, checkbox, file, email, phone, promo, select, radio, gmaps)
  • required – значение опции “Обязательное поле”
  • pos – позиция поля в списке полей
  • dig – тип товара, при котором поле выводится в магазине. Возможные значения:
    -1 - любого типа
    0 - Материальный товар
    1 - Товар является файлом
    2 - Товар - электронный код
    3 - Услуга
  • afld – указывает с каким полем из карточки пользователя ассоциировать данное поле. Возможные значения:
    пустое значение - нет ассоциации
    full_name - Имя
    phone - Телефон
    email - E-mail
    gender - Пол
    state - Штат
    city - Город
    msn - MSN
    aol - AOL
    icq - ICQ
    yahoo - Yahoo
    signature - Подпись
    birthday - Дата рождения
GETSHOP /uapi/shop/getshopdata/?page=order_fields_list
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/getshopdata/', array( 'page' => 'order_fields_list', )); print_r($response); //Получаем ответ ?>
{ "success":{ "2": { "required": 0, "afld": "", "name": "Адрес доставки", "type": "textarea", "dig": 0, "pos": 2, "expand": 1 }, "1": { "name": "Контактный телефон", "afld": "", "required": 0, "pos": 1, "expand": 1, "dig": -1, "type": "phone" }, "8": { "afld": "", "name": "Название поля №8", "required": 0, "expand": 1, "pos": 8, "type": "promo", "dig": -1 }, "3": { "expand": 1, "pos": 3, "type": "text", "dig": -1, "afld": "", "name": "text", "required": 0 }, "6": { "type": "email", "dig": -1, "expand": 1, "pos": 6, "required": 0, "afld": "", "name": "почта" }, "4": { "required": 0, "name": "Название поля №4", "afld": "", "dig": -1, "type": "checkbox", "expand": 1, "pos": 4 }, "5": { "pos": 5, "expand": 1, "type": "select", "dig": -1, "values": [ "1", "2", "3" ], "required": 0, "afld": "", "name": "Название поля №5" }, "7": { "afld": "", "name": "Название поля №7", "required": 0, "pos": 7, "expand": 1, "type": "file", "dig": -1 } } }
 

[GET] Получение списка отображаемых в заказе полей товара


  • page=order_goods_fields_list – [Строка] - указывает, что нужно получить список отображаемых в заказе полей товара

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ "success":{ DATA } }

Расшифровка ответа сервера

DATA - секция со списком отображаемых в заказе полей товара. CODE записи - код поля товара в магазине. Значение записи - название поля товара в текущей локализации сайта.

GETSHOP /uapi/shop/getshopdata/?page=order_goods_fields_list
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/getshopdata/', array( 'page' => 'order_goods_fields_list', )); print_r($response); //Получаем ответ ?>
{ "success":{ "name": "Наименование", "price_in": "Входящая", "price": "Цена", "sum": "Сумма", "cnt": "Кол-во" } }
 

[PUT] Модификация примечания к заказу


  • mode=inv_note_save – [Строка] - действие, которое нужно выполнить - изменить примечания к заказу
  • id=ORDER_ID – [Число] - номер заказа
  • note=ORDER_NOTE – [Строка] - текст примечания к заказу

В случае ошибки

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ 'success': { "msg": "Комментарий успешно изменен" } }
PUTSHOP /uapi/shop/getshopdata/?mode=inv_note_save&id=ORDER_ID¬e=ORDER_NOTE
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/shop/checkout/', array( 'mode' => 'inv_note_save', 'id' => 180, 'note' => 'текст примечания', )); print_r($response); // Получаем ответ ?>
{ "success":{ "msg": "Комментарий успешно изменен" } }

Яндекс.Метрика