Главная > Документация 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". Будут отобраны заказы у которых период доставки попадает в указанный период
  • payment=PAYMЕNT_ID – [Число] – фильтр - ID способа облаты. Будут отобраны заказы с указанным способом оплаты
  • delivery=DELIVERY_ID – [Число] – фильтр - ID способа доставки. Будут отобраны заказы с указанным способом доставки
  • id=IDS – [Строка] – фильтр - ID заказа(ов), перечисленных через запятую. Будут отобраны заказы с указанными ID
  • date=DATES – [Строка] – фильтр - диапазон дат добавления в формате "date1|date2". Будут отобраны заказы, дата добавления которых попадает в указанный период

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

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 } }

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

  • 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". Будут отобраны заказы у которых период доставки попадает в указанный период
  • payment=PAYMЕNT_ID – [Число] – фильтр - ID способа облаты. Будут отобраны заказы с указанным способом оплаты
  • delivery=DELIVERY_ID – [Число] – фильтр - ID способа доставки. Будут отобраны заказы с указанным способом доставки
  • id=IDS – [Строка] – фильтр - ID заказа(ов), перечисленных через запятую. Будут отобраны заказы с указанными ID
  • date=DATES – [Строка] – фильтр - диапазон дат добавления в формате "date1|date2". Будут отобраны заказы, дата добавления которых попадает в указанный период

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

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/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] Добавить товар в заказ


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

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

{ '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". Будут отобраны заказы у которых период доставки попадает в указанный период
  • payment=PAYMЕNT_ID – [Число] – фильтр - ID способа облаты. Будут отобраны заказы с указанным способом оплаты
  • delivery=DELIVERY_ID – [Число] – фильтр - ID способа доставки. Будут отобраны заказы с указанным способом доставки
  • id=IDS – [Строка] – фильтр - ID заказа(ов), перечисленных через запятую. Будут отобраны заказы с указанными ID
  • date=DATES – [Строка] – фильтр - диапазон дат добавления в формате "date1|date2". Будут отобраны заказы, дата добавления которых попадает в указанный период

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

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”
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] Назначение группы заказу


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

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

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

{ 'error' => { ERROR_DATA } }

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

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

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

  • hide=ORDER_GROUP – [Число] – группа заказа, которую нужно назначить. Если параметр не указан, то заказу(ам) будет назначена группа “0 - “В работе””
    Возможные значения:
    0 - “В работе”
    1 - “В архиве”
    2 - “В корзине”
PUTSHOP /uapi/shop/invoices/?mode=hide&mode=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', 'mode'=>'ID_LIST' )); print_r($response); //Получаем ответ ?>
{ "success":{ "msg":"Заказ(ы) перенесены ..." } }
 

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


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

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

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

{ 'error' => { ERROR_DATA } }

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

{ "success":{ "msg":"~Для заказа(ов) ... курьер ... установлен" } }
PUTSHOP /uapi/shop/invoices/?mode=setCourier&mode=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', 'mode'=>'ID_LIST', 'group_courier'=>'COURIER', )); print_r($response); //Получаем ответ ?>
{ "success":{ "msg":"Для заказа(ов) ... статус ... установлен" } }
Яндекс.Метрика