Основы uAPI

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

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

[GET] Получить содержимое корзины


Показывает весь текущий список товаров, которые находятся в вашей корзине

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

{ 'error' => { ERROR_DATA } }

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

{ 'success': { BASKET_DATA } }

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

  • user_id=USER_ID – [Число] - ID пользователя. Если указано, то будет возвращено информацию о корзине указанного пользователя. Учитывается, только если пользователь, от имени которого делается запрос, имеет права администратора.

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

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

  • info – дополнительная информация по корзине (предупреждения, предложения)
  • weight – суммарный вес всех товаров в корзине
  • items_count – количество товарных позиций в корзине
  • goods_count – количество товаров в корзине
  • discount – суммарная скидка по корзине
  • total – суммарная стоимость корзины (в у.е. магазина)
  • items – ITEMS - секция с данными по товарам корзины. ID подсекции - порядковый номер товарной позиции в корзине.

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

  • id – ID записи товарной позиции
  • entry_id – ID товара
  • entry_title – наименова товара
  • entry_cat_id – ID категории товара
  • entry_brand – значение поля “Производитель”
  • entry_photo – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. thumb - URL к изображению-превю товара. photo - URL к полному изображению товара.
  • entry_hgu – ЧПУ товара
  • entry_shop_url – URL товара в магазине
  • entry_type – тип товара (0 - материальный товар, 1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
  • entry_price – цена товара
  • entry_price_in – входящая цена товара
  • entry_price_vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • entry_price_vat_eval – цена товара без НДС (если в настройках магазина включен расчет НДС)
  • over – наценка по товару с учетом всех выбранных опций
  • cnt – количество единиц товара
  • summ – стоимость товара с учетом всех наценок и количества единиц товара
  • entry_unit – значение поля “Единица”
  • entry_weight – вес товара
  • entry_art_no – значение поля “Артикул”
  • entry_warr – значение поля “Гарантия”
  • entry_others – секция со значениями дополнительных полей товара. Количество елеметов секции зависит от количества дополнительных полей товара, установленного в настройках магазина.
  • entry_options – выбранные опции товара
  • entry_is_in_discount – признак, что товар включается в расчет скидок
  • entry_is_in_wishlist – признак, что товар добавлен в список желаний текущего пользователя
  • entry_add_uid – ID пользователя, добавившего товар
  • entry_add_user – логин пользователя, добавившего товар
GETSHOP /uapi/shop/basket/
<?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/basket/', array( //без параметров )); print_r($response); //Получаем ответ ?>
{ "success":{ "basket":{ "info":"", "weight":"", "items_count":1, "goods_count":1, "discount":0, "total":60, "items":[ { "entry_is_in_discount":1, "entry_art_no":"", "over":{ "summ_raw":"0.00", "summ":0 }, "entry_is_in_wishlist":0, "entry_options":"", "entry_weight":{ "weight":0, "weight_raw":0 }, "entry_add_user":"uAPI", "entry_unit":"шт.", "entry_add_uid":"7", "entry_id":"4", "id":"7", "entry_cat_id":"5", "entry_price_vat":{ "price_raw":0, "price":0 }, "entry_price":{ "price_raw":60, "price":"60.00$" }, "entry_price_in":{ "price_raw":"50.00", "price":"50.00$" }, "entry_price_vat_eval":{ "price_raw":60, "price":"60.00$" }, "entry_brand":"", "entry_others":{ "other3":"", "other2":"", "other1":"" }, "entry_hgu":"gejmpad-dlja-smartfonov-i-planshetov-icontrolpad", "entry_shop_url":"http://yoursite.ucoz.ru/shop/4/desc/gejmpad-dlja-smartfonov-i-planshetov-icontrolpad", "entry_type":"0", "cnt":"1", "summ":{ "summ_raw":60, "summ":"60.00$" }, "entry_title":"Геймпад для смартфонов и планшетов iControlpad", "entry_photo":{ "small":"http://yoursite.ucoz.ru/_sh/00/4s.jpg", "photo":"http://yoursite.ucoz.ru/_sh/00/4.jpg", "thumb":"http://yoursite.ucoz.ru/_sh/00/4m.jpg" }, "entry_warr":"" } ] } } }
 

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


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

  • cnt=GOODS_CNT – [Число] – количество единиц товара (значение по умолчанию 1)
  • opt=OPTIONS – [Строка] – строка с выбранными опциями в формате “<OPTION_ID>-<ID_SELECTED_VALUE>:<OPTION_ID>-<ID_SELECTED_VALUE>:...,” где OPTION_ID - ID опции, ID_SELECTED_VALUE - ID выбранного значения
  • now=1 – [Число] – признак, указывающий что нужно сделать операцию "Купить сейчас"

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

{ 'error' => { ERROR_DATA } }

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

{ 'success': { "msg": "Товар успешно добавлен в корзину", BASKET_DATA } }

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

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

  • info – дополнительная информация по корзине (предупреждения, предложения)
  • weight – суммарный вес всех товаров в корзине
  • items_count – количество товарных позиций в корзине
  • goods_count – количество товаров в корзине
  • discount – суммарная скидка по корзине
  • total – суммарная стоимость корзины (в у.е. магазина)
  • items – ITEMS - секция с данными по товарам корзины. ID подсекции - порядковый номер товарной позиции в корзине.

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

  • id – ID записи товарной позиции
  • entry_id – ID товара
  • entry_title – наименова товара
  • entry_cat_id – ID категории товара
  • entry_brand – значение поля “Производитель”
  • entry_photo – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. thumb - URL к изображению-превю товара. photo - URL к полному изображению товара.
  • entry_hgu – ЧПУ товара
  • entry_shop_url – URL товара в магазине
  • entry_type – тип товара (0 - материальный товар, 1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
  • entry_price – цена товара
  • entry_price_in – входящая цена товара
  • entry_price_vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • entry_price_vat_eval – цена товара без НДС (если в настройках магазина включен расчет НДС)
  • over – наценка по товару с учетом всех выбранных опций
  • cnt – количество единиц товара
  • summ – стоимость товара с учетом всех наценок и количества единиц товара
  • entry_unit – значение поля “Единица”
  • entry_weight – вес товара
  • entry_art_no – значение поля “Артикул”
  • entry_warr – значение поля “Гарантия”
  • entry_others – секция со значениями дополнительных полей товара. Количество елеметов секции зависит от количества дополнительных полей товара, установленного в настройках магазина.
  • entry_options – выбранные опции товара
  • entry_is_in_discount – признак, что товар включается в расчет скидок
  • entry_is_in_wishlist – признак, что товар добавлен в список желаний текущего пользователя
  • entry_add_uid – ID пользователя, добавившего товар
  • entry_add_user – логин пользователя, добавившего товар
POSTSHOP /uapi/shop/basket/?mode=add&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->get('/shop/basket/', array( 'mode' => 'add', 'id' => 'GOODS_ID' )); print_r($response); //Получаем ответ ?>
{ "success":{ "msg":"Товар успешно добавлен в корзину", "basket":{ "info":"", "weight":"", "items_count":2, "goods_count":2, "discount":0, "total":60, "items":[ { "entry_is_in_discount":1, "entry_art_no":"", "over":{ "summ_raw":"0.00", "summ":0 }, "entry_is_in_wishlist":0, "entry_options":"", "entry_weight":{ "weight":0, "weight_raw":0 }, "entry_add_user":"uAPI", "entry_unit":"шт.", "entry_add_uid":"7", "entry_id":"4", "id":"7", "entry_cat_id":"5", "entry_price_vat":{ "price_raw":0, "price":0 }, "entry_price":{ "price_raw":60, "price":"60.00$" }, "entry_price_in":{ "price_raw":"50.00", "price":"50.00$" }, "entry_price_vat_eval":{ "price_raw":60, "price":"60.00$" }, "entry_brand":"", "entry_others":{ "other3":"", "other2":"", "other1":"" }, "entry_hgu":"gejmpad-dlja-smartfonov-i-planshetov-icontrolpad", "entry_shop_url":"http://yoursite.ucoz.ru/shop/4/desc/gejmpad-dlja-smartfonov-i-planshetov-icontrolpad", "entry_type":"0", "cnt":"1", "summ":{ "summ_raw":60, "summ":"60.00$" }, "entry_title":"Геймпад для смартфонов и планшетов iControlpad", "entry_photo":{ "small":"http://yoursite.ucoz.ru/_sh/00/4s.jpg", "photo":"http://yoursite.ucoz.ru/_sh/00/4.jpg", "thumb":"http://yoursite.ucoz.ru/_sh/00/4m.jpg" }, "entry_warr":"" }, { "entry_is_in_discount":1, "entry_art_no":"", "over":{ "summ_raw":0, "summ":0 }, "entry_is_in_wishlist":0, "entry_options":"", "entry_weight":{ "weight":0, "weight_raw":0 }, "entry_add_user":"Dmitry_DM", "entry_unit":"шт.", "entry_add_uid":"1", "entry_id":"49", "id":"8", "entry_cat_id":"1", "entry_price_vat":{ "price_raw":0, "price":0 }, "entry_price":{ "price_raw":0, "price":"0.00$" }, "entry_price_in":{ "price_raw":"0.00", "price":"0.00$" }, "entry_price_vat_eval":{ "price_raw":0, "price":0 }, "entry_brand":"", "entry_others":{ "other3":"", "other2":"", "other1":"" }, "entry_hgu":"fsdfsdf", "entry_shop_url":"http://yoursite.ucoz.ru/shop/49/desc/fsdfsdf", "entry_type":"0", "cnt":"1", "summ":{ "summ_raw":0, "summ":0 }, "entry_title":"fsdfsdf", "entry_photo":{ "small":"http://yoursite.ucoz.ruhttp://s4.ucoz.net/img/sh/nfs.png", "photo":"http://yoursite.ucoz.ruhttp://s4.ucoz.net/img/sh/nf.png", "thumb":"http://yoursite.ucoz.ruhttp://s4.ucoz.net/img/sh/nf.png" }, "entry_warr":"" } ] } } }
 

[DELETE] Удалить товар из корзины


Удалить товар из корзины. Если не указать параметр id – произойдет очистка корзины

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

{ 'error' => { ERROR_DATA } }

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

{ 'success': { "msg": "Товар успешно удален из корзины", BASKET_DATA } }

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

  • id=RECORD_ID – [Число] - ID записи товарной позиции в корзине, которую нужно удалить. Если параметр не указан, то будет выполнена очистка корзины

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

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

  • info – дополнительная информация по корзине (предупреждения, предложения)
  • weight – суммарный вес всех товаров в корзине
  • items_count – количество товарных позиций в корзине
  • goods_count – количество товаров в корзине
  • discount – суммарная скидка по корзине
  • total – суммарная стоимость корзины (в у.е. магазина)
  • items – ITEMS - секция с данными по товарам корзины. ID подсекции - порядковый номер товарной позиции в корзине.

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

  • id – ID записи товарной позиции
  • entry_id – ID товара
  • entry_title – наименова товара
  • entry_cat_id – ID категории товара
  • entry_brand – значение поля “Производитель”
  • entry_photo – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. thumb - URL к изображению-превю товара. photo - URL к полному изображению товара.
  • entry_hgu – ЧПУ товара
  • entry_shop_url – URL товара в магазине
  • entry_type – тип товара (0 - материальный товар, 1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
  • entry_price – цена товара
  • entry_price_in – входящая цена товара
  • entry_price_vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • entry_price_vat_eval – цена товара без НДС (если в настройках магазина включен расчет НДС)
  • over – наценка по товару с учетом всех выбранных опций
  • cnt – количество единиц товара
  • summ – стоимость товара с учетом всех наценок и количества единиц товара
  • entry_unit – значение поля “Единица”
  • entry_weight – вес товара
  • entry_art_no – значение поля “Артикул”
  • entry_warr – значение поля “Гарантия”
  • entry_others – секция со значениями дополнительных полей товара. Количество елеметов секции зависит от количества дополнительных полей товара, установленного в настройках магазина.
  • entry_options – выбранные опции товара
  • entry_is_in_discount – признак, что товар включается в расчет скидок
  • entry_is_in_wishlist – признак, что товар добавлен в список желаний текущего пользователя
  • entry_add_uid – ID пользователя, добавившего товар
  • entry_add_user – логин пользователя, добавившего товар
DELETESHOP /uapi/shop/basket/?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->delete('/shop/basket/', array( 'id' => 'GOODS_ID' )); print_r($response); //Получаем ответ ?>
//в процессе получения
 

Изменение количества товара в корзине - [PUT]


id=RECORD_ID - [Число] - ID записи товарной позиции в корзине, по которой нужно изменить данные

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

{ 'error' => { ERROR_DATA } }

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

{ 'success': { "msg": "Количество успешно изменено", BASKET_DATA } }

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

  • cnt=GOODS_CNT – [Число] – количество единиц товара (значение по умолчанию 1)
  • opt=OPTIONS – [Строка] – строка с выбранными опциями в формате “<OPTION_ID>-<ID_SELECTED_VALUE>:<OPTION_ID>-<ID_SELECTED_VALUE>:...,” где OPTION_ID - ID опции, ID_SELECTED_VALUE - ID выбранного значения
  • now=1 – [Число] – признак, указывающий что нужно сделать операцию "Купить сейчас"

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

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

  • info – дополнительная информация по корзине (предупреждения, предложения)
  • weight – суммарный вес всех товаров в корзине
  • items_count – количество товарных позиций в корзине
  • goods_count – количество товаров в корзине
  • discount – суммарная скидка по корзине
  • total – суммарная стоимость корзины (в у.е. магазина)
  • items – ITEMS - секция с данными по товарам корзины. ID подсекции - порядковый номер товарной позиции в корзине.

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

  • id – ID записи товарной позиции
  • entry_id – ID товара
  • entry_title – наименова товара
  • entry_cat_id – ID категории товара
  • entry_brand – значение поля “Производитель”
  • entry_photo – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. thumb - URL к изображению-превю товара. photo - URL к полному изображению товара.
  • entry_hgu – ЧПУ товара
  • entry_shop_url – URL товара в магазине
  • entry_type – тип товара (0 - материальный товар, 1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
  • entry_price – цена товара
  • entry_price_in – входящая цена товара
  • entry_price_vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
  • entry_price_vat_eval – цена товара без НДС (если в настройках магазина включен расчет НДС)
  • over – наценка по товару с учетом всех выбранных опций
  • cnt – количество единиц товара
  • summ – стоимость товара с учетом всех наценок и количества единиц товара
  • entry_unit – значение поля “Единица”
  • entry_weight – вес товара
  • entry_art_no – значение поля “Артикул”
  • entry_warr – значение поля “Гарантия”
  • entry_others – секция со значениями дополнительных полей товара. Количество елеметов секции зависит от количества дополнительных полей товара, установленного в настройках магазина.
  • entry_options – выбранные опции товара
  • entry_is_in_discount – признак, что товар включается в расчет скидок
  • entry_is_in_wishlist – признак, что товар добавлен в список желаний текущего пользователя
  • entry_add_uid – ID пользователя, добавившего товар
  • entry_add_user – логин пользователя, добавившего товар
PUTSHOP /uapi/shop/basket/
<?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/basket/', array( 'mode'=>'put', 'id'=>7, 'cnt'=>3 )); print_r($response); //Получаем ответ ?>
{ "success":{ "msg":"Количество успешно изменено" "basket":{ "info":"", "weight":"", "items_count":1, "goods_count":3, "discount":0, "total":180, "items":[ { "entry_is_in_discount":1, "entry_art_no":"", "over":{ "summ_raw":"0.00", "summ":0 }, "entry_is_in_wishlist":0, "entry_options":"", "entry_weight":{ "weight":0, "weight_raw":0 }, "entry_add_user":"uAPI", "entry_unit":"шт.", "entry_add_uid":"7", "entry_id":"4", "id":"7", "entry_cat_id":"5", "entry_price_vat":{ "price_raw":0, "price":0 }, "entry_price":{ "price_raw":60, "price":"60.00$" }, "entry_price_in":{ "price_raw":"50.00", "price":"50.00$" }, "entry_price_vat_eval":{ "price_raw":60, "price":"60.00$" }, "entry_brand":"", "entry_others":{ "other3":"", "other2":"", "other1":"" }, "entry_hgu":"gejmpad-dlja-smartfonov-i-planshetov-icontrolpad", "entry_shop_url":"http://yoursite.ucoz.ru/shop/4/desc/gejmpad-dlja-smartfonov-i-planshetov-icontrolpad", "entry_type":"0", "cnt":"3", "summ":{ "summ_raw":60, "summ":"60.00$" }, "entry_title":"Геймпад для смартфонов и планшетов iControlpad", "entry_photo":{ "small":"http://yoursite.ucoz.ru/_sh/00/4s.jpg", "photo":"http://yoursite.ucoz.ru/_sh/00/4.jpg", "thumb":"http://yoursite.ucoz.ru/_sh/00/4m.jpg" }, "entry_warr":"" } ] } } }

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