Developers

lists

API Methods

offers-types-list
Format:

GET /api/rest/webmaster/xml/offers-types-list

Descritption:

Returns the directory of offer type filters

Input parameters:
Response:
  • <getOffersTypesListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>string</item>
      </data>
    </getOffersTypesListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offers-types-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
offers-tools-list
Format:

GET /api/rest/webmaster/xml/offers-tools-list

Descritption:

Returns the directory of tools

Input parameters:
Response:
  • <getOffersToolsListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <code>string</code>
        • <name>string</name>
        </item>
      </data>
    </getOffersToolsListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offers-tools-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
languages-list
Format:

GET /api/rest/webmaster/xml/languages-list

Descritption:

Returns the directory of languages

Input parameters:
Response:
  • <getLanguagesListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <code>string</code>
        • <name>string</name>
        </item>
      </data>
    </getLanguagesListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/languages-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
geo-list
Format:

GET /api/rest/webmaster/xml/geo-list

Descritption:

Returns the directory of regions

Input parameters:
Response:
  • <getGeoListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <parent_id>int</parent_id>
        • <code>string</code>
        • <count>int</count>
        • <items>
          • <item>
            • <parent_id>int</parent_id>
            • <code>string</code>
            • <count>int</count>
            • <items>
              • <item>
                • <parent_id>int</parent_id>
                • <code>string</code>
                • <count>int</count>
                • <items>
                  • <item></item>
                  </items>
                • <title>string</title>
                • <value>int</value>
                </item>
              </items>
            • <title>string</title>
            • <value>int</value>
            </item>
          </items>
        • <title>string</title>
        • <value>int</value>
        </item>
      </data>
    </getGeoListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/geo-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
offers-categories-list
Format:

GET /api/rest/webmaster/xml/offers-categories-list/{type}

Descritption:

Returns the directory of offer categories

Input parameters:
Type:Name:Description:Possible values:Required:
enumtypeweb, mobile
 
Response:
  • <getOffersCategoriesListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <parent_id>int</parent_id>
        • <code>string</code>
        • <count>int</count>
        • <items>
          • <item>
            • <parent_id>int</parent_id>
            • <code>string</code>
            • <count>int</count>
            • <items>
              • <item>
                • <parent_id>int</parent_id>
                • <code>string</code>
                • <count>int</count>
                • <items>
                  • <item></item>
                  </items>
                • <title>string</title>
                • <value>int</value>
                </item>
              </items>
            • <title>string</title>
            • <value>int</value>
            </item>
          </items>
        • <title>string</title>
        • <value>int</value>
        </item>
      </data>
    </getOffersCategoriesListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offers-categories-list/web?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
offers-traffictypes-list
Format:

GET /api/rest/webmaster/xml/offers-traffictypes-list/{type}

Descritption:

Returns the directory of traffic types

Input parameters:
Type:Name:Description:Possible values:Required:
enumtypeweb, mobile
 
Response:
  • <getOffersTrafficTypesListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        </item>
      </data>
    </getOffersTrafficTypesListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offers-traffictypes-list/web?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
offers-platforms-list
Format:

GET /api/rest/webmaster/xml/offers-platforms-list

Descritption:

Returns the directory of mobile platforms

Input parameters:
Response:
  • <getOffersMobilePlatformsListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        </item>
      </data>
    </getOffersMobilePlatformsListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/offers-platforms-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
goods-categories-list
Format:

GET /api/rest/webmaster/xml/goods-categories-list/{type}

Descritption:

Returns the directory of goods categories. Directory contains links to market.yandex.ru categories.

Input parameters:
Type:Name:Description:Possible values:Required:
enumtypegoods, marketplace
 
Response:
  • <getGoodsCategoriesListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <parent_id>int</parent_id>
        • <name>string</name>
        • <yandex_category_id>string</yandex_category_id>
        • <offers_count>int</offers_count>
        • <items>
          • <item>
            • <id>int</id>
            • <parent_id>int</parent_id>
            • <name>string</name>
            • <yandex_category_id>string</yandex_category_id>
            • <offers_count>int</offers_count>
            • <items>
              • <item>
                • <id>int</id>
                • <parent_id>int</parent_id>
                • <name>string</name>
                • <yandex_category_id>string</yandex_category_id>
                • <offers_count>int</offers_count>
                • <items>
                  • <item></item>
                  </items>
                </item>
              </items>
            </item>
          </items>
        </item>
      </data>
    </getGoodsCategoriesListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/goods-categories-list/goods?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
goods-brands-list
Format:

GET /api/rest/webmaster/xml/goods-brands-list/{type}

Descritption:

Returns the directory of brands

Input parameters:
Type:Name:Description:Possible values:Required:
enumtypegoods, marketplace
 
Response:
  • <getGoodsBrandsListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <value>int</value>
      • <title>string</title>
      • <items>
        • <item>
          • <id>int</id>
          • <name>string</name>
          • <offers_count>int</offers_count>
          • <title>string</title>
          • <value>int</value>
          </item>
        </items>
      </data>
    </getGoodsBrandsListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/goods-brands-list/goods?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
goods-currency-list
Format:

GET /api/rest/webmaster/xml/goods-currency-list

Descritption:

Returns the directory of currencies of goods catalogue.

Input parameters:
Response:
  • <getGoodsCurrencyListResponseData>
    • <status>
        200|204|400|403|500|
      </status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>string</item>
      </data>
    </getGoodsCurrencyListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/goods-currency-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
couponstatus
Format:

GET /api/rest/webmaster/xml/couponstatus

Descritption:

Returns the directory of coupon statuses

Input parameters:
Response:
  • <getCouponStatusResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        • <description>string</description>
        </item>
      </data>
    </getCouponStatusResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/couponstatus?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
couponcategories
Format:

GET /api/rest/webmaster/xml/couponcategories

Descritption:

Returns coupon categories guide

Input parameters:
Response:
  • <getCouponCategoriesResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        </item>
      </data>
    </getCouponCategoriesResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/couponcategories?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
coupontypes
Format:

GET /api/rest/webmaster/xml/coupontypes

Descritption:

Returns coupon types (Promo code, Promo event, etc.) guide

Input parameters:
Response:
  • <getCouponTypesResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        </item>
      </data>
    </getCouponTypesResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/coupontypes?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
couponother
Format:

GET /api/rest/webmaster/xml/couponother

Descritption:

Additional coupon list filter

Input parameters:
Response:
  • <getCouponOtherResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <item>
        • <id>int</id>
        • <name>string</name>
        </item>
      </data>
    </getCouponOtherResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/couponother?remote_auth=6420072d37bf14f1df182d0fe0efa2d9