Developers
goods and coupons

goods and coupons

API Methods

goods
Format:

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>

Descritption:

Returns goods list

Input parameters:
Type:Name:Description:Possible values:Required:
intstartnumber of current page. 0 by default
 
intlimitnumber of elements per page. 50 by default, 1000 maximum
 
stringgeofilter by region. Integer identifiers shall be listed separated by commas. See regions guide
 
stringcategoriesfilter by goods categories. Integer identifiers shall be listed separated by commas. See goods' categories guide
 
stringbrandsfilter by brands. Integer identifiers shall be listed separated by commas. See goods' brands guide
 
stringofferfilter by offers. Integer identifiers shall be listed separated by commas. See list of offers
 
stringcurrencyfilter by currencies. Integer identifiers shall be listed separated by commas. See currencies' quide
 
stringshopfilter by shop ids. Integer identifiers shall be listed separated by commas
 
stringskuSKU filter
 
stringsubaccount
 
intmin_price
 
intmax_price
 
stringkeywordsearching by substring in good's name
 
inttraffic_channel_idfilter by traffic channels. Integer identifier. See traffic channels guide
 
enumsimilarxml, json
 
enumsortnumber of elements per pageid, name, link, title, price, old_price, delivery, brand, credit, rating, discount, retargeting, currency, sku, upc, image
 
enumsort_typesort by fieldasc, desc
 
enumavailableavailable goodstrue, false
 
stringfilterdownloads filter
 
Response:
  • <getGoodsResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <total>int</total>
      • <items>
        • <item>
          • <id>string <!--article id--></id>
          • <shop_offer_id>string <!--article shop id--></shop_offer_id>
          • <name>string <!--article name--></name>
          • <offer_name>string <!--offer name--></offer_name>
          • <offer_id>int <!--offer id--></offer_id>
          • <price>float <!--article price--></price>
          • <old_price>float <!--old price of article--></old_price>
          • <_3mepc>float <!--webmaster's revenue from 1000 clicks for 3 months--></_3mepc>
          • <_7depc>float <!--webmaster's revenue from 1000 clicks for 7 days--></_7depc>
          • <region> <!--article regions-->
            • <item>
              • <id>int <!--geo id--></id>
              • <code>string <!--geo code--></code>
              • <title>string <!--geo title--></title>
              </item>
            </region>
          • <delivery>string <!--delivery--></delivery>
          • <category>string <!--goods categories--></category>
          • <category_id>int <!--category id--></category_id>
          • <brand>string <!--article brand--></brand>
          • <coupons>string <!--whether this article is a coupon--></coupons>
          • <credit>string <!--possibility to buy article on credit--></credit>
          • <rating>int</rating>
          • <update_date>string <!--article update date--></update_date>
          • <retargeting>boolean <!--retargeting--></retargeting>
          • <discount>string <!--discount--></discount>
          • <currency>string <!--article currency--></currency>
          • <sku>string <!--article id--></sku>
          • <upc>string <!--article universal code--></upc>
          • <image>string <!--article picture--></image>
          • <shop_id>int <!--store number--></shop_id>
          • <text>string</text>
          • <orders>string</orders>
          • <url>string</url>
          • <properties> <!--goods properties-->
            • <item>
              • <name>string</name>
              • <value>string</value>
              </item>
            </properties>
          • <similarGoods>string</similarGoods>
          </item>
        </items>
      </data>
    </getGoodsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/goods?remote_auth=6420072d37bf14f1df182d0fe0efa2d9
coupons
Format:

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>&sort=<enum>&sort_type=<enum>&filter=<string>

Descritption:

Get coupon list

Input parameters:
Type:Name:Description:Possible values:Required:
intstartnumber of current page. 0 by default
 
intlimitnumber of elements per page. 50 by default, 1000 maximum
 
stringkeywordfilter by substring in name or description
 
stringgeofilter by region. Integer identifiers shall be listed separated by commas. See regions guide
 
stringcategoriesfilter by categories. Integer identifiers shall be listed separated by commas. See categories guide
 
stringoffersfilter by offers. Integer identifiers shall be listed separated by commas. See list of offers
 
stringstatusfilter by statuses, which determine the state of the activity of the coupon (New, Expected, etc.). Integer identifiers shall be listed separated by commas. See goods' statuses guide
 
stringtypefilter by type (Promo code, Promo event, etc.) of coupons. Integer identifiers shall be listed separated by commas. See goods' types guide
 
intotheradditional filter. Integer identifiers shall be listed separated by commas. See additional filter
 
stringsubaccountsubaccount
 
inttraffic_channel_idfilter by traffic channel. Integer identifier. See traffic channels guide
 
stringcoupon_categoriesfilter by coupon category. Integer IDs are separated by commas. See coupon categories guide
 
booleanis_exclusiveshows whether the coupon is offered exclusively by CityAds
 
enumsortsort by fieldid, 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_typesort directionasc, desc
 
stringfiltersaved custom filter
 
Response:
  • <getCouponsResponseData>
    • <status>int</status>
    • <error>string</error>
    • <request_id>int</request_id>
    • <data>
      • <total>int</total>
      • <items>
        • <item>
          • <id>int <!--article id--></id>
          • <image>string <!--picture--></image>
          • <offer_logo>string <!--Connected offer logo--></offer_logo>
          • <name>string <!--coupon name--></name>
          • <description>string <!--coupon description--></description>
          • <start_date>string <!--date and time of beginning of the coupon--></start_date>
          • <active_to>string <!--coupon date and operation time--></active_to>
          • <coupon_type>string <!--coupone type--></coupon_type>
          • <promo_code>string <!--whether coupon is a promo code--></promo_code>
          • <offer_name>string <!--offer name--></offer_name>
          • <offer_id>int <!--offer id--></offer_id>
          • <status>string <!--coupon statuses--></status>
          • <status_id>string <!--coupon status ids--></status_id>
          • <category_id>int <!--Offer category ID--></category_id>
          • <action_category_name>string <!--offer category name--></action_category_name>
          • <coupon_category_id>string <!--coupon category id--></coupon_category_id>
          • <coupon_category_name>string <!--coupon category name--></coupon_category_name>
          • <retargeting>boolean <!--retargeting--></retargeting>
          • <geo> <!--coupon regions-->
            • <item>
              • <id>int <!--geo id--></id>
              • <code>string <!--geo code--></code>
              • <title>string <!--geo title--></title>
              </item>
            </geo>
          • <rating>float <!--coupon rating--></rating>
          • <url>string <!--link to coupon--></url>
          • <url_frame>string <!--link to coupon in frame--></url_frame>
          • <look> <!--online / offline-->
              online|offline|
            </look>
          • <domain>string</domain>
          </item>
        </items>
      </data>
    </getCouponsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/coupons?remote_auth=6420072d37bf14f1df182d0fe0efa2d9