{ "opencollection": "1.0.0", "info": { "name": "Public Account Pairing Endpoints Manager Loyalty Endpoints API", "version": "v1" }, "items": [ { "info": { "name": "Manager Loyalty Endpoints", "type": "folder" }, "items": [ { "info": { "name": "Otter Get Enrollment Config for a Loyalty Provider", "type": "http" }, "http": { "method": "GET", "url": "https://{public-api-url}/manager/loyalty/v1/:source/user/enrollment-config", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 8 per minute`\n" }, { "info": { "name": "Otter Get User by Id", "type": "http" }, "http": { "method": "GET", "url": "https://{public-api-url}/manager/loyalty/v1/:source/user", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 8 per minute`\n" }, { "info": { "name": "Otter Create a Loyalty User", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/loyalty/v1/:source/user", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 8 per minute`\n" }, { "info": { "name": "Otter Search Loyalty Users", "type": "http" }, "http": { "method": "GET", "url": "https://{public-api-url}/manager/loyalty/v1/:source/user/search", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "token", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "source", "value": "", "type": "path" }, { "name": "term", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 8 per minute`\n" }, { "info": { "name": "Otter Compute Applicable Rewards", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/loyalty/v1/:source/rewards/evaluate", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`Supply both userId and order to get a list of applicable rewards for an order. Supply only userId to get a list of rewards the user can redeem` `RATE LIMIT: 8 per minute`\n" }, { "info": { "name": "Otter Simulate Rewards", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/loyalty/v1/:source/rewards/simulate", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`Show what the effects will be after applying the selected rewards, and start the rewards transaction, only call this when user selected some reward, otherwise skip this call and use redeemAndAccumulateRewards API call.` `RATE LIMIT: 8 per minute`\n" }, { "info": { "name": "Otter Redeem and Accumulate Rewards", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/loyalty/v1/:source/rewards/redeem-and-accumulate", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`Redeem existing rewards and accumulate new rewards` `RATE LIMIT: 8 per minute`\n" }, { "info": { "name": "Otter Refund Rewards", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/loyalty/v1/:source/rewards/refund", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 8 per minute`\n" } ] } ], "bundled": true }