Developers

Товары и купоны

Содержание

Описание методов API

goods
Формат:

GET /api/rest/webmaster/xml/goods?start=<int>&limit=<int>&geo=<string>&categories=<string>&brands=<string>&offer=<string>&currency=<string>&shop=<string>&sku=<string>&subaccount=<string>&min_price=<int>&max_price=<int>&keyword=<string>&traffic_channel_id=<int>&similar=<enum>&sort=<enum>&sort_type=<enum>&available=<enum>&filter=<string>

Описание:

Возвращает список товаров

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
intstartномер текущей страницы. По умолчанию 0
 
intlimitколичество элементов на странице. По умолчанию 50, но не более 1000
 
stringgeoфильтр по региону. Целочисленные идентификаторы перечисляются через запятую. См. справочник регионов
 
stringcategoriesфильтр по категориям товаров. Целочисленные идентификаторы перечисляются через запятую. См. справочник категорий товаров
 
stringbrandsфильтр по брендам. Целочисленные идентификаторы перечисляются через запятую. См. справочник брендов
 
stringofferфильтр по офферам. Целочисленные идентификаторы перечисляются через запятую. См. список офферов
 
stringcurrencyфильтр по валютам. Целочисленные идентификаторы перечисляются через запятую. См. список валют
 
stringshopфильтр по магазинам. Целочисленные идентификаторы магазинов перечисляются через запятую
 
stringskuфильтр по SKU
 
stringsubaccountсубаккаунт
 
intmin_priceминимальная цена товара
 
intmax_priceмаксимальная цена товара
 
stringkeywordпоиск по подстроке в имени товара
 
inttraffic_channel_idфильтр по каналам трафика. Целочисленный идентификатор. См. справочник каналов трафика
 
enumsimilarxml, json
 
enumsortсортировка по полюid, name, link, title, price, old_price, delivery, brand, credit, rating, discount, retargeting, currency, sku, upc, image
 
enumsort_typeпорядок сортировкиasc, desc
 
enumavailableтолько доступные товарыtrue, false
 
stringfilterфильтр выгрузок
 
Ответ:
  • <getGoodsResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <total>int</total>
      • <items>
        • <item>
          • <id>string <!--id товара --></id>
          • <shop_offer_id>string <!--идентификатор товара в магазине--></shop_offer_id>
          • <name>string <!--наименование товара--></name>
          • <offer_name>string <!--назваие оффера--></offer_name>
          • <offer_id>int <!--id оффера--></offer_id>
          • <price>float <!--цена товара--></price>
          • <old_price>float <!--старая цена товара--></old_price>
          • <_3mepc>float <!--доход вебмастера с тысячи кликов за 3 месяца --></_3mepc>
          • <_7depc>float <!--доход вебмастера с тысячи кликов за семь дней--></_7depc>
          • <region> <!--регионы товара-->
            • <item>
              • <id>int <!--id гео--></id>
              • <code>string <!--код гео--></code>
              • <title>string <!--Регион--></title>
              </item>
            </region>
          • <delivery>string <!--доставка--></delivery>
          • <category>string <!--категории--></category>
          • <category_id>int <!--id категории--></category_id>
          • <brand>string <!--бренд товара--></brand>
          • <coupons>string <!--является ли данный продукт купоном--></coupons>
          • <credit>string <!--возможность взять товар в кредит--></credit>
          • <rating>int <!--популярность товара--></rating>
          • <update_date>string <!--дата обновления товара--></update_date>
          • <retargeting>boolean <!--наличие ретаргетинга--></retargeting>
          • <discount>string <!--скидка--></discount>
          • <currency>string <!--валюта товара--></currency>
          • <sku>string <!--артикул товара--></sku>
          • <upc>string <!--универсальный код товара--></upc>
          • <image>string <!--изображение товара--></image>
          • <shop_id>int <!--номер магазина--></shop_id>
          • <text>string</text>
          • <orders>string</orders>
          • <url>string</url>
          • <properties> <!--свойства товара-->
            • <item>
              • <name>string</name>
              • <value>string</value>
              </item>
            </properties>
          • <similarGoods>string</similarGoods>
          </item>
        </items>
      </data>
    </getGoodsResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/goods?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
coupons
Формат:

GET /api/rest/webmaster/xml/coupons?start=<int>&limit=<int>&keyword=<string>&geo=<string>&categories=<string>&offers=<string>&status=<string>&type=<string>&other=<int>&subaccount=<string>&traffic_channel_id=<int>&coupon_categories=<string>&is_exclusive=<boolean>&is_personal=<boolean>&ids=<string>&coupon_lang=<string>&sectoring=<string>&sort=<enum>&sort_type=<enum>&filter=<string>

Описание:

Получить список купонов

Входные параметры:
Тип:Имя:Описание:Допустимые значения:Обязательное:
intstartномер текущей страницы. По умолчанию 0
 
intlimitколичество элементов на странице. По умолчанию 50, но не более 1000
 
stringkeywordфильтр по подстроке в имени или описании.
 
stringgeoфильтр по региону. Целочисленные идентификаторы перечисляются через запятую. См. справочник регионов
 
stringcategoriesфильтр по категориям офферов. Целочисленные идентификаторы перечисляются через запятую. См. справочник категорий
 
stringoffersфильтр по офферам. Целочисленные идентификаторы перечисляются через запятую. См. список офферов
 
stringstatusфильтр по статусам, которые определяют состояние активности купона (Новый, Ожидаемый и т.д.). Целочисленные идентификаторы перечисляются через запятую. См. справочник статусов купонов
 
stringtypeфильтр по типам (Промокод, Акция и т.д.) купонов. Целочисленные идентификаторы перечисляются через запятую. См. справочник типов купонов
 
intotherдополнительный фильтр. Целочисленные идентификаторы перечисляются через запятую. См. список дополнительных фильтров
 
stringsubaccountсубаккаунт
 
inttraffic_channel_idфильтр по каналам трафика. Целочисленный идентификатор. См. справочник каналов трафика
 
stringcoupon_categoriesфильтр по категориям купонов. Целочисленные идентификаторы перечисляются через запятую. См. справочник категорий купонов
 
booleanis_exclusiveпризнак того, что данный купон есть только в cityads
 
booleanis_personalпризнак того, что данный купон доступен индивидуально вебмастеру
 
stringidsфильтр по идентификаторам купонов. Целочисленные идентификаторы перечисляются через запятую.
 
stringcoupon_langфильтр по языку купона. Буквенный код языка. См. справочник языков
 
stringsectoringфильтр по маркировке
 
enumsortсортировка по полюid, name, rating, description, active_to, promo_code, offer_name, offer_id, status, promo_code, offer_name, retargeting, status, promo_code, offer_name, coupon_type
 
enumsort_typeпорядок сортировкиasc, desc
 
stringfilterсохраненный пользовательский фильтр
 
Ответ:
  • <getCouponsResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <total>int</total>
      • <items>
        • <item>
          • <id>int <!--id товара --></id>
          • <image>string <!--изображение--></image>
          • <offer_logo>string <!--логотип связанного оффера--></offer_logo>
          • <name>string <!--название купона--></name>
          • <description>string <!--описание купона--></description>
          • <start_date>string <!--дата и время начала действия купона--></start_date>
          • <active_to>string <!--дата и время действия купона--></active_to>
          • <coupon_type>string <!--тип купона--></coupon_type>
          • <promo_code>string <!--является ли супон промокодом--></promo_code>
          • <offer_name>string <!--название оффера--></offer_name>
          • <offer_id>int <!--id оффера--></offer_id>
          • <status>string <!--статусы купона--></status>
          • <status_id>string <!--идентификаторы статуса--></status_id>
          • <category_id>int <!--id категории оффера--></category_id>
          • <action_category_name>string <!--название категории оффера--></action_category_name>
          • <coupon_category_id>string <!--id категории купона--></coupon_category_id>
          • <coupon_category_name>string <!--название категории купона--></coupon_category_name>
          • <coupon_lang>string <!--язык купона--></coupon_lang>
          • <is_exclusive>boolean <!--эксклюзивный--></is_exclusive>
          • <is_personal>boolean <!--индивидуальный--></is_personal>
          • <retargeting>boolean <!--наличие ретаргетинга--></retargeting>
          • <sectoring>string <!--Маркировка--></sectoring>
          • <geo> <!--регионы купона-->
            • <item>
              • <id>int <!--id гео--></id>
              • <code>string <!--код гео--></code>
              • <title>string <!--Регион--></title>
              </item>
            </geo>
          • <rating>float <!--рейтинг купона. Параметр устарел--></rating>
          • <url>string <!--ссылка на купон--></url>
          • <url_frame>string <!--ссылка на купон в фрейме--></url_frame>
          • <look> <!--онлайн / офлайн. Параметр устарел-->
              online|offline|
            </look>
          • <domain>string</domain>
          </item>
        </items>
      </data>
    </getCouponsResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/coupons?remote_auth=6420072d37bf14f1df182d0fe0efa2d9