The loyalty program management api allows you to manage your loyalty program. The Loyalty Program Management API is available at https://connect.ignite.cloud/loyalty
\nThrough this api you can manage:
\nThis API is also available in Swagger documentation format on SwaggerHub
\nThis API mandates a valid JWT signed and issued by auth.ignite.cloud via our authentication partner Auth0 for access. JWT verification is conducted by our API Gateway, triggering a 400 error response in case of cryptographic tampering, replay attacks, expired tokens, tokens signed with future dates or scopes/permissions that do not authorize you to use this API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"20512336","collectionId":"364d3cea-b80a-4196-8185-09ad313d65a0","publishedId":"2sA35G2MDL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-29T00:41:47.000Z"},"item":[{"name":"amenities","item":[{"name":"amenity","item":[{"name":"{id}","item":[{"name":"bulk_import_amenities","item":[{"name":"Upload an amenity to multiple locations","id":"245baddc-aff9-436a-9118-620fb324e16e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"(Required)
\n","key":"locations","value":"","type":"text"}]},"url":"https://connect.ignite.cloud/loyalty/amenities/amenity/:id/bulk_import_amenities/","description":"Bulk adds the available amenity to multiple locations via the amenity_id.
\n","urlObject":{"path":["amenities","amenity",":id","bulk_import_amenities",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"16c7b9a5-a39d-4711-a6e4-a7606c3c036f","description":{"content":"(Required) A unique integer value identifying this amenities.
\n","type":"text/plain"},"type":"any","value":"Gets a detailed app based on amenity id
\n","urlObject":{"path":["amenities","amenity",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"1fa1ceca-fec8-4c17-818a-bd3b24b68d33","description":{"content":"(Required) A unique integer value identifying this amenities.
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","key":"enabled","value":"(Required)
\n","key":"id","value":"(Required)
\n","key":"locations","value":"(Required)
\n","key":"name","value":"Updates all information of an amenity
\n","urlObject":{"path":["amenities","amenity",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"01dea36e-c9cf-4913-bea5-9ddd7a43d23a","description":{"content":"(Required) A unique integer value identifying this amenities.
\n","type":"text/plain"},"type":"any","value":"Updates only the fields provided for the amenity id supplied
\n","urlObject":{"path":["amenities","amenity",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"09d6ef7a-0ea7-43a4-b10a-d13cd2354381","description":{"content":"(Required) A unique integer value identifying this amenities.
\n","type":"text/plain"},"type":"any","value":"Sets an amenity to inactive
\n","urlObject":{"path":["amenities","amenity",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"d41ba393-2b74-4650-a8c2-667043d6cfb6","description":{"content":"(Required) A unique integer value identifying this amenities.
\n","type":"text/plain"},"type":"any","value":"Returns list of all amenities.
\n","urlObject":{"path":["amenities","amenity",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[{"description":{"content":"Number of results to return per page.
\n","type":"text/plain"},"key":"limit","value":"The initial index from which to return the results.
\n","type":"text/plain"},"key":"offset","value":"(Required)
\n","key":"enabled","value":"(Required)
\n","key":"id","value":"(Required)
\n","key":"locations","value":"(Required)
\n","key":"name","value":"Adds a new amenity for the list
\n","urlObject":{"path":["amenities","amenity",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[]}},"response":[{"id":"bda3b159-8dde-4967-985e-8334988fe158","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required)
\n","key":"locations","value":"","type":"text"}]},"url":"https://connect.ignite.cloud/loyalty/amenities/fuel_brand/:id/bulk_import_fuel_brands/","description":"Bulk adds the available fuel brand to multiple locations via the id.
\n","urlObject":{"path":["amenities","fuel_brand",":id","bulk_import_fuel_brands",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"344f903e-6e63-4fa8-852d-5cac6d83136f","description":{"content":"(Required) A unique integer value identifying this fuel brands.
\n","type":"text/plain"},"type":"any","value":"Gets a detailed fuel brand based on fuel brand id
\n","urlObject":{"path":["amenities","fuel_brand",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"20e7bb1f-dce9-4216-9b78-d33a9a28818d","description":{"content":"(Required) A unique integer value identifying this fuel brands.
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","key":"enabled","value":"(Required)
\n","key":"fuel_brand","value":"(Required)
\n","key":"id","value":"(Required)
\n","key":"locations","value":"Updates all information of a fuel brand
\n","urlObject":{"path":["amenities","fuel_brand",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"286a83fa-057b-4820-bbef-6ef3ecd4fc1c","description":{"content":"(Required) A unique integer value identifying this fuel brands.
\n","type":"text/plain"},"type":"any","value":"Updates only the fields provided for the fuel brand id supplied
\n","urlObject":{"path":["amenities","fuel_brand",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"32a98497-cbb0-4309-8537-ffeff7309991","description":{"content":"(Required) A unique integer value identifying this fuel brands.
\n","type":"text/plain"},"type":"any","value":"Sets a fuel brand to inactive
\n","urlObject":{"path":["amenities","fuel_brand",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"5781e98e-e3ad-4906-b84a-7458d67b5bd8","description":{"content":"(Required) A unique integer value identifying this fuel brands.
\n","type":"text/plain"},"type":"any","value":"Returns list of all fuel brands.
\n","urlObject":{"path":["amenities","fuel_brand",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[{"description":{"content":"Number of results to return per page.
\n","type":"text/plain"},"key":"limit","value":"The initial index from which to return the results.
\n","type":"text/plain"},"key":"offset","value":"(Required)
\n","key":"enabled","value":"(Required)
\n","key":"fuel_brand","value":"(Required)
\n","key":"id","value":"(Required)
\n","key":"locations","value":"Adds a new fuel brand for the list
\n","urlObject":{"path":["amenities","fuel_brand",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[]}},"response":[{"id":"d7796a24-66b0-455c-bdaf-a4576b64018b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerReturns list of all amenities and a list of all fuel brands
\n","urlObject":{"path":["amenities",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[{"description":{"content":"Number of results to return per page.
\n","type":"text/plain"},"key":"limit","value":"The initial index from which to return the results.
\n","type":"text/plain"},"key":"offset","value":"The \"amenities\" REST endpoint is designed to enhance the convenience store loyalty program by providing detailed information about the amenities (Deli, Car Wash, ATM, Shower, etc.) and fuel brands (Chevron, Shell, Exxon, etc.) available at different store locations. For customers on the road, knowing where they can find specific fuel types or amenities like a vacuum station or propane exchange can save time and enhance their travel experience. By clearly listing available services, the loyalty program increases customer engagement and satisfaction, potentially driving more frequent visits.
\nlimit and offset parameters control pagination.limit and offset for pagination.id.amenity_id.id.limit and offset for pagination.id.id.id.Use HTTP requests to interact with the API. Pagination is optional but recommended for endpoints returning lists.
\n*_List Amenities with Pagination:__*_GET /amenities/amenity?limit=10&offset=0
\nDetailed fuel brand information:
\nGET /amenities/fuel_brand/{id}
\n*Bulk Update Locations with an Amenity_*_POST /amenities/amenity/{id}/bulk_import_amenities
\n","_postman_id":"569fdb8d-1ca8-4171-b38c-e43049e3496a"},{"name":"dashboards","item":[{"name":"dashboards list","id":"12e98787-d534-44e5-b461-b08be1395d51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://connect.ignite.cloud/loyalty/dashboards/?limit=Number of results to return per page.
\n","type":"text/plain"},"key":"limit","value":"The initial index from which to return the results.
\n","type":"text/plain"},"key":"offset","value":"The purpose of this endpoint is to provide a list of available dashboards for the user. The user typically accesses these dashboard through https://portal.ignite.cloud or https://command-center.com/
\nThe endpoint is only accessible with a valid Bearer Token, which is required for authentication. The limit and offset parameters can be used to control the number of results returned per page.
\nHere are some examples of how to use this endpoint:
\n(Required) A unique integer value identifying this enrollment field.
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","key":"custom","value":"(Required)
\n","key":"hidden","value":"(Required)
\n","key":"id","value":"(Required)
\n","key":"label","value":"(Required)
\n","key":"light","value":"(Required)
\n","key":"name","value":"(Required)
\n","key":"required","value":"Updates all fields of an enrollment field
\n","urlObject":{"path":["enrollment_fields",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"637cc1d0-2787-4fc7-8189-7a45d66e47e1","description":{"content":"(Required) A unique integer value identifying this enrollment field.
\n","type":"text/plain"},"type":"any","value":"Returns only the fields passed as input for a given enrollment field
\n","urlObject":{"path":["enrollment_fields",":id",""],"host":["https://connect.ignite.cloud/loyalty"],"query":[],"variable":[{"id":"f178c55b-f729-4071-a06c-071d4e4ac09f","description":{"content":"(Required) A unique integer value identifying this enrollment field.
\n","type":"text/plain"},"type":"any","value":"