Skip to navigation

Get Promotion Details

This endpoint returns details of a particular promotion based on the promotion_id sent in the request. The output displays information about the merchant running the promotion and the promotion itself including the merchant’s name, username, location details, validity of promotion, and link to the shop among other fields.

Request Body

  • promotion_id (string): The id of the promotion.

Response

  • name (string): The name of the promotion.

  • description (string): The description of the promotion.

  • merchant_name (string): The name of the associated merchant.

  • merchant_username (string): The username of the associated merchant.

  • merchant_user_image (string): The image URL of the merchant.

  • image (string): The image URL related to the promotion.

  • address_1 (string): The primary address line of the merchant.

  • address_2 (string): The secondary address line of the merchant.

  • postcode (string): The postal code for the merchant’s location.

  • city (string): The city of the merchant’s location.

  • state (string): The state of the merchant’s location.

  • country (string): The country of the merchant’s location.

  • full_address (string): The full address for the merchant’s location.

  • validity_period (integer): The time length of the promotion validity.

  • url (string): The URL of the merchant shop.

  • link_title (string): The title to display for the provided URL.

  • promo_code (string): The promotional code for the promotion.

Query parameters

api_tokenstringOptional

Response

Get Promotion Details
messagestringOptional
apistringOptional
statusstringOptional
dataobjectOptional