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 metadata (object)
            • Changed property swap (object)
              Metadata for swap loyalty rules
              • Added property from (object)
                • Property mode (string) Enum values:
                  • any
                  • specific
                • Property chain (number) One of: Enum value:
                  • any
                • Property tokens (array) Items (object):
                  • Property address (string)
                  • Property chainId (string)
                • Property trackAmount (boolean)
              • Added property to (object)
              • Deleted property tokenMode (string)
              • Deleted property swappedToChain (number)
              • Deleted property swappedToTokens (array)
              • Deleted property trackTokenAmount (boolean)
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 metadata (object)
    Additional metadata for the loyalty rule
    • Changed property swap (object)
      Metadata for swap loyalty rules
      • Added property from (object)
        • Property mode (string)
        • Property chain (object) One of:
        • Property tokens (array)
        • Property trackAmount (boolean)
      • Added property to (object)
      • Deleted property tokenMode (string)
      • Deleted property swappedToChain (object)
      • Deleted property swappedToTokens (array)
      • Deleted property trackTokenAmount (boolean)
Return Type:
Changed response : 200 OK
200
  • Changed content type : application/json
    • Changed property metadata (object)
      Additional metadata for the loyalty rule
      • Changed property swap (object)
        Metadata for swap loyalty rules
        • Added property from (object)
        • Added property to (object)
        • Deleted property tokenMode (string)
        • Deleted property swappedToChain (number)
        • Deleted property swappedToTokens (array)
        • Deleted property trackTokenAmount (boolean)
POST /api/loyalty/rules/
Request:
Changed content type : application/json
  • Changed property metadata (object)
    Additional metadata for the loyalty rule
    • Changed property swap (object)
      Metadata for swap loyalty rules
      • Added property from (object)
      • Added property to (object)
      • Deleted property tokenMode (string)
      • Deleted property swappedToChain (object)
      • Deleted property swappedToTokens (array)
      • Deleted property trackTokenAmount (boolean)
Return Type:
Changed response : 200 OK
200
  • Changed content type : application/json
    • Changed property metadata (object)
      Additional metadata for the loyalty rule
      • Changed property swap (object)
        Metadata for swap loyalty rules
        • Added property from (object)
        • Added property to (object)
        • Deleted property tokenMode (string)
        • Deleted property swappedToChain (number)
        • Deleted property swappedToTokens (array)
        • Deleted property trackTokenAmount (boolean)

​
Result

API changes are backward compatible