Stores API

With this API, you can build a script in PHP, Python, Java or NodeJS to fetch list of stores from CouponAPI's Database.

NOTE: This API is not available in Basic Plan.

API Endpoint

GET  https://couponapi.org/api/getStores/

Sample Request

https://couponapi.org/api/getStores/?API_KEY=[YOUR_API_KEY]

Request Parameters

• API_KEY (required) (string)
• subscription_details (optional) (boolean)
  
  • Possible Values: 0,1
    
  • Default Value: 0
  • Explanation: If you set this parameter to true the response will include additional details about your subscription for each store.
    
• subscribed (optional) (boolean)
  
  • Possible Values: 0,1
  • Default Value: 0
  • Explanation: If you set this parameter to true the response will be filtered to include only those stores that you have subscribed in your CouponAPI Account.
    

Success Response:

• result: (boolean) true
• stores (array)
  
  • name: (string) Unique store name. In most cases, this will be the primary domain name of the merchant website
    
  • location: (string) Comma separated list of Countries in which this store operates. If we are unable to determine a specific geography for any store, this field will be empty.
    
  • URL: (url) Homepage URL for the merchant website.
    
  • added_on: (date-time) UTC Date-Time when the store was added to CouponAPI database. Format: yyyy-mm-dd HH:MM:SS
    
  • enabled: (boolean) Subscription Status of this store in your CouponAPI account. This field is only returned if your "subscription_details" parameter was set to true.
    
  • subscribed_on: (date-time) UTC Date-Time when the store was subscribed in your CouponAPI account. This field is only returned if your "subscription_details" parameter was set to true. Format: yyyy-mm-dd HH:MM:SS
  • custom_name: (string) Custom Mapping for this store in your CouponAPI account. This field is only returned if your "subscription_details" parameter was set to true.

Error Response:

• result: (boolean) false
• error: (string) Reason for failure