Resource: Promo Codes (preliminary)

Topics:

Actions

  • - (Object) index

Url:

  • [GET] /rest/v1/report/promo_codes?[arguments]
Note:

This action requires admin access.

Note:

The maximum date range (from/to) is limited to one year.

Returns the total number of consumed promo codes in date range

Arguments:

  • (String) from

    Begin date in iso8601 format.

  • (String) to

    End date in iso8601 format.

  • (Integer) offer_id

    (optional) Should be numberic or ‘all’. Default: ‘all’

Example Request:

https://service_name.synctv.com/rest/v1/report/promo_codes?from=2011-12-07T00:00:00Z&to=2012-01-07T00:00:00Z

Example Response:

<ssap>
  <response>
    <code>1</code>
    <message>Successfully completed.</message>
    <count>1</count>
  </response>
  <version>0.5</version>
  <promo_codes>100</promo_codes>
</ssap>

Response Fields:

  • (Integer) promo_codes

    List of total consumed promo codes in date range and by offer_id if specified.