Jump to Content

Guides Discussions

Home Guides API Reference Changelog Discussions

v1.0

Guides Discussions

API Reference

v1.0

All

Pages

Start typing to search…

Getting Started

Getting Started with Loyal and Save

Authentication API

Basic Token Responses
api/v1/customer/auth/login
api/v1/customer/auth/register
api/v1/customer/logout
api/v1/customer/auth/change-password
api/v1/customer/auth/send-password-reset
api/v1/customer/auth/verify-code
api/v1/customer/auth/password-reset
api/v1/customer/auth/verify-email
api/v1/customer/auth/verify-username
api/v1/customer/auth/associate-fb

API Basics

API Filtering

Customer API

api/v1/customer/details
api/v1/customer/details/{id}
api/v1/customer/{id}/gift
api/v1/customer/{id}/share-gift
api/v1/customer/full-search
api/v1/customer/{id}/join-team
api/v1/customer/associate-reg-token
api/v1/customer/{id}/block
api/v1/customer/{id}/unblock
api/v1/customer/{id}/my-allowed-stores
api/v1/customer/{id}/allowed-stores
api/v1/customer/block-list
api/v1/customer/poll-update
api/v1/customer/rank-info
api/v1/customer/rank-info/{id}
api/v1/customer/email-referral-code
api/v1/customer/accept-consent/{id}
api/v1/customer/check-consent/{id}
api/v1/customer/get-consent-content
api/v1/customer/get-consent-topics
api/v1/customer/save-consent-preferences
api/v1/customer/login-info/update
api/v1/customer/auth/app-version

Store API

api/v1/customer/stores
api/v1/customer/stores/get-filter-tags-list
api/v1/customer/stores/available
api/v1/customer/stores/{id}/get
api/v1/customer/stores/{id}/locations
api/v1/customer/stores/{id}/campaigns
api/v1/customer/stores/{id}/team
api/v1/customer/stores/{id}/all-team
api/v1/customer/stores/{id}/register
api/v1/customer/stores/{id}/remove
api/v1/customer/stores/by-customer/{id}
api/v1/customer/stores/{id}/update-prefs
api/v1/customer/stores/{id}/add-feedback
api/v1/customer/stores/{id}/online-store-available
/api/v1/customer/stores/{id}/team-levels
/api/v1/customer/stores/{id}/team-with-level
/api/v1/customer/stores/{id}/campaign-tags
api/v1/customer/auth/get-account-by-slug
api/v1/customer/stores/get-distance-filter-list
api/v1/customer/stores/{id}/survey-options
api/v1/customer/stores/{id}/post-survey
api/v1/customer/stores/{id}/consent-status
api/v1/customer/stores/{id}/save-consent
api/v1/customer/stores/{id}/in-app-promotions
api/v1/customer/stores/{id}/review/{id}
api/v1/customer/stores/{id}/reviews
api/v1/customer/stores/{id}/locations/{locationId}/set-home-store

Coupon API

/api/v1/customer/coupons
/api/v1/customer/coupons/{storeId}
/api/v1/customer/my-coupons

Customer Campaigns

/api/v1/customer/campaigns
/api/v1/customer/campaigns/completed
/api/v1/customer/campaigns/{id}/register
api/v1/customer/campaigns/{id}/get
/api/v1/customer/campaigns/my-campaigns
/api/v1/customer/campaigns/customer/{id}
api/v1/customer/campaigns/hot-campaigns
/api/v1/customer/manufacturers/campaigns/{id}/register
api/v1/customer/campaigns/near-by-popular-campaigns
/api/v1/customer/campaigns/get-filter-list
api/v1/customer/campaigns/all-campaigns
api/v1/customer/campaigns/single-campaign

Receipts API

/api/v1/customer/receipts
/api/v1/customer/receipts/{id}
/api/v1/customer/receipts/{id}/image
api/v1/customer/receipts/{id}/hide
api/v1/customer/receipts/all

News API

api/v1/customer/news-updates

Profile Update API

api/v1/customer/profile-update

Friend API

api/v1/customer/friend-list
api/v1/customer/{id}/add-friend
api/v1/customer/{id}/remove-friend
api/v1/customer/friend-requests
api/v1/customer/friend-requests/{id}
api/v1/customer/friend-requests/{id}/accept
api/v1/customer/friend-requests/{id}/deny
api/v1/customer/friend-list/{id}
api/v1/customer/friend-requests/{id}/cancel

Team Request API

api/v1/customer/team-requests
api/v1/customer/{id}/send-team-request
api/v1/customer/team-requests/{id}/accept
api/v1/customer/team-requests/{id}/deny
api/v1/customer/team-requests/{id}/cancel

Message API

api/v1/customer/messages
api/v1/customer/messages/unread
api/v1/customer/messages/{id}/view
api/v1/customer/messages/{id}/get
api/v1/customer/messages/find-group
api/v1/customer/messages/create
api/v1/customer/messages/{id}/reply
api/v1/customer/messages/{id}/leave
api/v1/customer/messages/{id}/add-member
api/v1/customer/messages/{id}/remove-member
api/v1/customer/messages/{id}/unread
api/v1/customer/messages/{id}/change-name
api/v1/customer/messages/{id}/mark-read
api/v1/customer/messages/{id}/toggle-notifications

Avatar API

api/v1/customer/avatars

Balance API

api/v1/customer/balances

Earning History API

api/v1/customer/earning-history

Swag Shop API

api/v1/customer/swag-shop/products
api/v1/customer/swag-shop/products/{id}/get
api/v1/customer/swag-shop/categories
api/v1/customer/swag-shop/tags
api/v1/customer/swag-shop/wishlist/add-item
api/v1/customer/swag-shop/wishlist/remove-item
api/v1/customer/swag-shop/products/{id}/add-review
api/v1/customer/swag-shop/products/{id}/reviews
api/v1/customer/swag-shop/products/{id}/attributes
api/v1/customer/swag-shop/products/{id}/purchase
api/v1/customer/swag-shop/purchases
api/v1/customer/swag-shop/purchases/{id}/tracking
api/v1/customer/swag-shop/purchases/{id}/get
api/v1/customer/gifts/sent
api/v1/customer/gifts/received
api/v1/customer/gifts/{id}/accept
api/v1/customer/gifts/{id}/decline
api/v1/customer/gifts/redeemed
api/v1/customer/gifts/{id}/get
api/v1/customer/swag-shop/get-discount-products
api/v1/customer/swag-shop/
/api/v1/customer/swag-shop/all-categories

Shipping Address

api/v1/customer/addresses
api/v1/customer/addresses/create
api/v1/customer/addresses/{id}/update
api/v1/customer/addresses/{id}/remove
api/v1/customer/validate-address

App Feedback

api/v1/customer/add-feedback

Interest API

api/v1/customer/interests

Card API

api/v1/customer/cards
api/v1/customer/cards/add-card
api/v1/customer/cards/{id}/remove

Manufacturers

api/v1/customer/manufacturers
api/v1/customer/manufacturers/{id}/get
api/v1/customer/manufacturer/{id}/stores
api/v1/customer/manufacturers/{id}/locations
api/v1/customer/manufacturers/find-manufacturers
api/v1/customer/manufacturers/{id}/coupons
api/v1/customer/manufacturers/{id}/view
api/v1/customer/manufacturers/{id}/campaigns

Manuf. Swag Shop API

api/v1/customer/manufacturer/swag-shop/products
api/v1/customer/manufacturer/swag-shop/products/{id}/get
api/v1/customer/manufacturer/swag-shop/categories
api/v1/customer/manufacturer/swag-shop/tags
api/v1/customer/manufacturer/swag-shop/wishlist/add-item
api/v1/customer/manufacturer/swag-shop/wishlist/remove-item
api/v1/customer/manufacturer/swag-shop/products/{id}/add-review
api/v1/customer/manufacturer/swag-shop/products/{id}/reviews
api/v1/customer/manufacturer/swag-shop/products/{id}/attributes
api/v1/customer/manufacturer/swag-shop/products/{id}/purchase
api/v1/customer/manufacturer/swag-shop/purchases
api/v1/customer/manufacturer/swag-shop/purchases/{id}/tracking
api/v1/customer/manufacturer/swag-shop/purchases/{id}/get
api/v1/customer/manufacturer/gifts/sent
api/v1/customer/manufacturer/gifts/received
api/v1/customer/manufacturer/gifts/{id}/accept
api/v1/customer/manufacturer/gifts/{id}/decline
api/v1/customer/manufacturer/gifts/redeemed
api/v1/customer/manufacturer/gifts/{id}/get

Manuf. Customer Balance API

api/v1/customer/manufacturer/balances

Manuf. Earning History API

api/v1/customer/manufacturers/earning-history

Manuf. Campaigns

api/v1/customer/manufacturers/{id}/campaigns
api/v1/customer/manufacturers/campaigns/{id}/get
api/v1/customer/manufacturers/campaigns

Manuf. Update Preferences API

api/v1/customer/manufacturers/{id}/update-prefs

Lotto

api/v1/customer/lottery-purchases
api/v1/customer/set-lotto-status

Online Order

api/v1/customer/online-order/create
api/v1/customer/online-order/settings
api/v1/customer/online-order/get-distance
api/v1/customer/online-order/order-screen
api/v1/customer/online-order/get-reorder

Gamification

api/v1/customer/gamification/leaderboard
api/v1/customer/gamification/report-card
api/v1/customer/gamification/popular-states
api/v1/customer/gamification/locations
api/v1/customer/gamification/eip-campaigns
api/v1/customer/gamification/previous-inning-details
api/v1/customer/gamification/current-inning-details
api/v1/customer/gamification/profile
api/v1/customer/gamification/history
api/v1/customer/gamification/rewards
api/v1/customer/gamification/reward-history

Account Deactivate API

api/v1/customer/get-exit-questions
api/v1/customer/save-exit-questions
/api/v1/customer/delete-account

Altria API

/api/v1/customer/stores/{store_id}/altria-deals
/api/v1/customer/stores/{store_id}/manufacturer-promotion

EAIV

/api/v1/customer/verify/eaiv-status
/api/v1/customer/stores/{id}/save-eaiv
/api/v1/customer/verify/avt-status
/api/v1/customer/verify/kb-status
/api/v1/customer/stores/{id}/eaiv-completed
/api/v1/customer/stores/altria-eaiv-status
/api/v1/customer/stores/resubmit-altria-status

RJR Deals

/api/v1/customer/stores/{store_id}/rjr-deals

Powered by

/api/v1/customer/campaigns/{id}/register