Skip to main content

Snag Solutions - API Docs (v 0.1)


What’s Changed


GET /api/loyalty/rule_edits
Return Type:
Changed response : 200 OK
200
  • Changed content type : application/json
    • Changed property data (array) Changed items (object):
      • Changed property data (object)
        Data that was changed on the rule
        • Changed property metadata (object)
          Optional metadata for the loyalty rule
      • Changed property previousData (object)
        Previous data of the rule before the edit
        • Changed property metadata (object)
          Optional metadata for the loyalty rule
POST /api/loyalty/rule_edits//restore
Return Type:
Changed response : 200 OK
200
  • Changed content type : application/json
    • Changed property data (object)
      Data that was changed on the rule
      • Changed property metadata (object)
        Optional metadata for the loyalty rule
    • Changed property previousData (object)
      Previous data of the rule before the edit
      • Changed property metadata (object)
        Optional metadata for the loyalty rule
GET /api/loyalty/rule_groups
Return Type:
Changed response : 200 OK
200
  • Changed content type : application/json
    • Changed property data (array) Changed items (object):
      Schema for a get loyalty rule groups response
      • Changed property loyaltyGroupItems (array) Changed items (object):
        • Changed property loyaltyRule (object)
          • Changed property frequency (string) Added enum value:
            • hourly
          • Changed property metadata (object)
            • Changed property isTokenHoldMultiplier (boolean)
              Flag indicating if the token hold multiplier is applied.
GET /api/loyalty/rules
Return Type:
Changed response : 200 OK
200
  • Changed content type : application/json
    • Changed property data (array) Changed items (object):
      • Changed property metadata (object)
        Optional metadata for the loyalty rule
POST /api/loyalty/rules
Request:
Changed content type : application/json
  • Changed property frequency (string)
    Execution frequency of the loyalty rule
    Added enum value:
    • hourly
  • Changed property interval (string)
    Interval between rule executions
    Added enum value:
    • hourly
  • Changed property metadata (object)
    Additional metadata for the loyalty rule
    • Changed property isTokenHoldMultiplier (boolean)
      Flag indicating if the token hold multiplier is applied.
Return Type:
Changed response : 200 OK
200
  • Changed content type : application/json
    • Changed property frequency (string)
      Execution frequency of the loyalty rule
      Added enum value:
      • hourly
    • Changed property interval (string)
      Interval between rule executions
      Added enum value:
      • hourly
    • Changed property metadata (object)
      Additional metadata for the loyalty rule
      • Changed property isTokenHoldMultiplier (boolean)
        Flag indicating if the token hold multiplier is applied.
POST /api/loyalty/rules/
Request:
Changed content type : application/json
  • Changed property metadata (object)
    Additional metadata for the loyalty rule
    • Changed property isTokenHoldMultiplier (boolean)
      Flag indicating if the token hold multiplier is applied.
  • Changed property frequency (string)
    Frequency of the rule execution
    Added enum value:
    • hourly
  • Changed property interval (string)
    Time interval for recurring rule execution
    Added enum value:
    • hourly
Return Type:
Changed response : 200 OK
200
  • Changed content type : application/json
    • Changed property metadata (object)
      Additional metadata for the loyalty rule
      • Changed property isTokenHoldMultiplier (boolean)
        Flag indicating if the token hold multiplier is applied.
    • Changed property frequency (string)
      Frequency of the rule execution
      Added enum value:
      • hourly
    • Changed property interval (string)
      Time interval for recurring rule execution
      Added enum value:
      • hourly

Result


API changes broke backward compatibility