{"info":{"_postman_id":"ce31b791-d0fd-4cdb-bb80-32b721cfc531","name":"Norbit API","description":"

Getting Started

\n

All APIs requires a mandatory header

\n
    \n
  1. X-Secret-Token - Authentication request header
    2. \n
\n

Authentication

\n

All APIs need to be authenticated using an authtoken. You can obtain it by contacting us.

\n

Errors

\n

Our APIs uses HTTP status codes to indicates success or failure of request. 2xx range means success, 4xx means error in request information and 5xx range indicates server error.

\n
    \n
  1. 200 - Success means request was completed
    2. \n
  2. 201 - Created means resource was created
    3. \n
  3. 400 - Error means there is malformed parameter or missing parameter
    4. \n
  4. 401 - Invalid Authentication Token
    5. \n
  5. 404 - URL not found
    6. \n
  6. 500 - Server error means there was unhandled errors from us
    7. \n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Authentication","slug":"authentication"},{"content":"Errors","slug":"errors"}],"owner":"2452357","collectionId":"ce31b791-d0fd-4cdb-bb80-32b721cfc531","publishedId":"S1TN8N1M","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"05AFF4"},"publishDate":"2020-01-30T13:51:16.000Z"},"item":[{"name":"Users","item":[{"name":"Retrieve Users","id":"d9484fec-653c-470c-98be-46c8ada87f44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}integrations/customers?start_datetime=2019-01-01&end_datetime=2019-05-28","description":"

This API endpoint is used to get a list of users and their details. The response will include all users who have signed up or updated their profile on and between the specified start and end dates.

\n

If the start date is not specified, the instance creation date will be assumed as the start date.

\n

If the end date is not specified, the present date will be assumed as the end date.

\n

If no start or end dates are specified, the date range will be the entire time span the app has existed.

\n
\n

Query Parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameRequiredData Type
start_datetimenoDate
end_datetimenoDate
\n
\n

Properties

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
user_idintegerUnique identifier
emailstringCustomer email
first_namestringCustomer's first name
last_namestringCustomer's last name
genderstringCustomer's gender
dobdateCustomer's birthday
mobile_numberstringCustomer's mobile number
suburbintegerCustomer's suburb
post_codestringCustomer's postcode
last_activity_timetimestampCustomer's last activity time
shopped_atjsonArray of retailer's category where customer shopped at
customer_segmentsjson[]Array of segment where customer belongs to
labelsstring[]Combination of segments and shopped at
\n
\n

Sample Response

\n
[\n    {\n        \"user_id\": 2029,\n        \"email\": \"joash@norbit.com.au\",\n        \"first_name\": \"Jason\",\n        \"last_name\": \"Callanta\",\n        \"gender\": \"male\",\n        \"dob\": \"1990-10-10\",\n        \"mobile_number\": \"0420789656\",\n        \"suburb\": \"brisbane - 4000\",\n        \"post_code\": \"4000\",\n        \"last_activity_time\": \"2019-02-13 12:12\",\n        \"shopped_at\" : {\n            \"retailer_categories\": [\n                { \"id\" : 1 , \"name\": \"Bank and Financial\"},\n                { \"id\" : 9 , \"name\": \"General\"}\n            ]\n        },\n        \"sign_up_time\": \"2019-01-31 11:00\",\n        \"customer_segments\": [{\n            \"name\" : \"All male\"\n        },{\n            \"name\" : \"Shopped at norbit\"\n        }],\n        \"labels\": [\"All male\", \"Shopped at norbit\", \"Bank and Financial\", \"General\"]\n    },\n    {\n        \"user_id\": 2015,\n        \"email\": \"anderson@norbit.com.au\",\n        \"first_name\": \"Anderson\",\n        \"last_name\": \"Austria\",\n        \"gender\": \"unspecified\",\n        \"dob\": null,\n        \"mobile_number\": null,\n        \"suburb\": null,\n        \"post_code\": null,\n        \"last_activity_time\": \"2019-05-28 17:39\",\n        \"shopped_at\" : {\n            \"retailer_categories\" : null\n        },\n        \"sign_up_time\": \"2019-03-15 15:32\",\n        \"customer_segments\": [{\n            \"name\" : \"All male\"\n        }],\n        \"labels\": [\"All male\"]\n    }\n]\n
","urlObject":{"path":["customers"],"host":["{{url}}integrations"],"query":[{"key":"start_datetime","value":"2019-01-01"},{"key":"end_datetime","value":"2019-05-28"}],"variable":[]}},"response":[],"_postman_id":"d9484fec-653c-470c-98be-46c8ada87f44"}],"id":"8bfdb44b-f54d-492a-bb16-bcd1edb016e6","description":"

Headers Parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
NameRequired
X-Secret-Tokentrue
\n
","event":[{"listen":"prerequest","script":{"id":"ea8e8d13-877d-451f-b80a-2ad2eb74c264","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3fac11e7-0a95-4672-a5e3-13b69a07503f","type":"text/javascript","exec":[""]}}],"_postman_id":"8bfdb44b-f54d-492a-bb16-bcd1edb016e6"},{"name":"Redemptions","item":[{"name":"Retrieve Redemptions","id":"c117e8f6-ca67-4a48-a793-9fc5e3891210","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}integrations/transactions?start_datetime=2019-05-01&end_datetime=2019-05-28","description":"

This API endpoint is used to get a list of user reward redemptions in the app. The response will include all reward redemptions by all users in the app on and between the specified start and end dates.

\n
\n

Query Parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameRequiredData Type
start_datetimetrueDate
end_datetimetrueDate
\n
\n

Properties

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
date_redeemeddateDate customer redeemed the reward
time_redeemedtimeTime customer redeemed the reward
date_claimeddateDate customer claimed the reward
time_claimedtimeTime customer claimed the reward
prize_idintegerReward's unique identifier
prize_namestringReward's short description
retailer_idintegerReward's retailer id
retailer_namestringReward's retailer name
emailstringCustomer's email
\n
\n

Sample Response

\n
[\n    {\n        \"date_redeemed\": \"2019-05-28\",\n        \"time_redeemed\": \"17:39:37\",\n        \"date_claimed\": \"2019-05-28\",\n        \"time_claimed\": \"18:15:52\",\n        \"prize_id\": 298,\n        \"prize_name\": \"Norbit Earrings\",\n        \"retailer_id\": 72,\n        \"retailer_name\": \"Norbit Fashions\",\n        \"email\": \"anderson@norbit.com.au\",\n        \"user_id\": 2015\n    },\n    {\n        \"date_redeemed\": \"2019-05-28\",\n        \"time_redeemed\": \"17:37:03\",\n        \"date_claimed\": \"\",\n        \"time_claimed\": \"\",\n        \"prize_id\": 298,\n        \"prize_name\": \"Norbit Earrings\",\n        \"retailer_id\": 72,\n        \"retailer_name\": \"Norbit Fashions\",\n        \"email\": \"jerome@norbit.com.au\",\n        \"user_id\": 1638\n    }\n]\n
","urlObject":{"path":["transactions"],"host":["{{url}}integrations"],"query":[{"key":"start_datetime","value":"2019-05-01"},{"key":"end_datetime","value":"2019-05-28"}],"variable":[]}},"response":[],"_postman_id":"c117e8f6-ca67-4a48-a793-9fc5e3891210"}],"id":"65584f40-0b3e-4e0b-a2e8-3832039c5420","description":"

Headers Parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
NameRequired
X-Secret-Tokentrue
\n
","event":[{"listen":"prerequest","script":{"id":"fe3d1ce4-aa74-4e5a-bdd8-602c412cee2c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"50570b57-f9ce-4562-a311-51fb59b53ad6","type":"text/javascript","exec":[""]}}],"_postman_id":"65584f40-0b3e-4e0b-a2e8-3832039c5420"},{"name":"Competitions","item":[{"name":"Retrieve AR Hunt Entries","id":"864f62e2-729b-4269-8853-1297495fb543","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}integrations/ar_entries?start_datetime=2019-01-01&end_datetime=2019-05-28","description":"

This API endpoint is used to get all Augmented Reality Hunt entries in the app. The response will include all AR Hunt competitions entries by all users in the app on and between the specified start and end dates.

\n
\n

Query Parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameRequiredData Type
start_datetimetrueDate
end_datetimetrueDate
\n
\n

Properties

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
competition_idintegerCompetition's unique identifier
competition_namestringCompetition's short description
entriesjson[]Array of entries
\n
\n

Sample Response

\n
[\n    {\n        \"competition_id\": 145,\n        \"comptition_name\": \"Sample AR Hunt\",\n        \"entries\": [\n            {\n                \"email\": \"jerome@norbit.com.au\",\n                \"first_name\": \"Jerome\",\n                \"last_name\": \"Geronimo\",\n                \"targets_found\": \"0\",\n                \"prize_collected\": \"false\",\n                \"times_completed\": 1,\n                \"first_entry\": \"2019-02-12 17:47\"\n            }\n        ]\n    }\n]\n
","urlObject":{"path":["ar_entries"],"host":["{{url}}integrations"],"query":[{"key":"start_datetime","value":"2019-01-01"},{"key":"end_datetime","value":"2019-05-28"}],"variable":[]}},"response":[],"_postman_id":"864f62e2-729b-4269-8853-1297495fb543"},{"name":"Draw Winners","id":"7a8b3dde-81ea-4b86-a128-fe96f76032c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImlkIjozLCJ1c2VybmFtZSI6ImRldmVsb3BtZW50QG5vcmJpdC5jb20uYXUiLCJ0eXBlIjoic3VwZXJBZG1pbiJ9LCJpYXQiOjE2Mjc4OTIzOTQsImV4cCI6MTYyNzk3ODc5NH0.g2bP6ti6kQqRVdUkngBilnnOfYgTgC18Jj1hxF1QFKQ"},{"key":"Content-Type","value":"application/json"},{"key":"x-token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImlkIjozLCJ1c2VybmFtZSI6ImRldmVsb3BtZW50QG5vcmJpdC5jb20uYXUiLCJ0eXBlIjoic3VwZXJBZG1pbiJ9LCJpYXQiOjE2Mjc4OTIzOTQsImV4cCI6MTYyNzk3ODc5NH0.g2bP6ti6kQqRVdUkngBilnnOfYgTgC18Jj1hxF1QFKQ","type":"text"}],"url":"{{url}}admin/competition/drawWinners/610?start_datetime=2021/06/01 00:00:00&end_datetime=2022/07/31 00:00:00&total_winners=2&x-token","urlObject":{"path":["competition","drawWinners","610"],"host":["{{url}}admin"],"query":[{"key":"start_datetime","value":"2021/06/01 00:00:00"},{"key":"end_datetime","value":"2022/07/31 00:00:00"},{"key":"total_winners","value":"2"},{"key":"x-token","value":null}],"variable":[]}},"response":[],"_postman_id":"7a8b3dde-81ea-4b86-a128-fe96f76032c9"}],"id":"be870c6b-85ff-46e3-92dd-77dfbf646bff","description":"

Headers Parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
NameRequired
X-Secret-Tokentrue
\n
","event":[{"listen":"prerequest","script":{"id":"dd63a6c3-6616-42b2-a68a-3736e2e801e8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab325479-7ef9-4ec3-8801-0f276e75fbb9","type":"text/javascript","exec":[""]}}],"_postman_id":"be870c6b-85ff-46e3-92dd-77dfbf646bff"}],"event":[{"listen":"prerequest","script":{"id":"35460b24-0031-4549-8f29-8eff6c4c84e9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"08f42b43-82d3-4b48-9c15-338c8497f8ca","type":"text/javascript","exec":[""]}}]}