This API Provider gives you access to update the various attributes stored in a GG User profile. Login, submit orders, initial signup, retrieve a user's favorite gifts, and manage contacts.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4028164","collectionId":"77eb2f09-4452-4209-a09f-758bffa31012","publishedId":"SzYW3fxj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-29T19:20:20.000Z"},"item":[{"name":"Password","item":[{"name":"Password Reset Request","id":"f61bed18-10ea-416d-9722-799121d468db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"{{email_address}}\"\n}"},"url":"{{url}}/api/password/reset","description":"Issue a password reset based on an email address.
\n","urlObject":{"path":["api","password","reset"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f61bed18-10ea-416d-9722-799121d468db"},{"name":"Password Reset Confirm","id":"365a4fa4-5d9b-4b65-96c4-b024d746eebc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\":\"{{user_id}}\",\n\t\"hash\":\"{{reset_hash}}\"\n}"},"url":"{{url}}/api/password/reset/confirm","description":"This API call is used for password reset confirmation (such as, in an email).
\n","urlObject":{"path":["api","password","reset","confirm"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"365a4fa4-5d9b-4b65-96c4-b024d746eebc"},{"name":"Password Reset Update","id":"aa34be18-739b-4670-bdd2-d16f84c788ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\":\"{{user_id}}}}\",\n\t\"hash\":\"{{reset_hash}}\",\n\t\"password\":\"{{password}}\",\n\t\"password_confirm\":\"{{password_confirm}}\"\n}"},"url":"{{url}}/api/password/reset/update","description":"This API request is used to update a user's password after a confirmed request.
\n","urlObject":{"path":["api","password","reset","update"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa34be18-739b-4670-bdd2-d16f84c788ed"}],"id":"aa6e2de4-35a4-4a51-bbbc-1d3e80778dcc","description":"Provider to manage passwords.
\n","_postman_id":"aa6e2de4-35a4-4a51-bbbc-1d3e80778dcc"},{"name":"Login","id":"14ebeca3-d00a-4d9c-bfef-ae5658244c8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"username\": \"{{email_address}}\",\n\t\"password\": \"{{password}}\"\n}"},"url":"{{url}}/api/user/signin","description":"Login a user. This creates a GG session when used.
\n","urlObject":{"path":["api","user","signin"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"14ebeca3-d00a-4d9c-bfef-ae5658244c8c"},{"name":"Update Credit Card","id":"829a3db2-4b35-44df-a51f-fc1bbdff20fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"device_id\": \"{{unique_device_id}}\",\n\t\"device_type\": \"{{device_type}}\",\n\t\"user_id\": \"{{user_token}}\",\n\t\"token\": \"{{user_token}}\",\n\t\"card_id\": \"{{new_card_id}}\",\n\t\"card_number\": \"{{card_number}}\",\n\t\"cvv\": \"{{cvv}}\",\n\t\"card_date\": \"{{expiry_date}}\"\n}"},"url":"{{url}}/api/update/cc","description":"Update the credit card of a user. This request is then sent over to Stripe and stored as a token.
\n","urlObject":{"path":["api","update","cc"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"829a3db2-4b35-44df-a51f-fc1bbdff20fa"},{"name":"Order Submit","id":"b34f2f40-0042-4c6a-bc93-ddab4c3e6245","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","type":"text","value":" {{client_id}}"},{"key":"Timestamp","type":"text","value":" {{request_timestamp}}"},{"key":"Request-Hash","type":"text","value":" {{generated_hash}}"}],"body":{"mode":"raw","raw":"{ \n \"device\":{ \n \"location\": \"{{location_id}}\",\n \"device_id\": \"{{unique_device_id}}\",\n \"device_type\": \"{{device_type}}\",\n \"user_id\": \"{{user_token}}\",\n \"token\": \"{{user_token}}\"\n },\n \"sender\":{ \n \"firstname\": \"{{sender_firstname}}\",\n \"lastname\": \"{{sender_lastname}}\",\n \"email\": \"{{sender_email_address}}\",\n \"phone\": \"{{sender_phone_number}}\",\n \"city\":\"Toronto\",\n \"country\":\"Canada\"\n },\n \"recipient\":{ \n \"contact\":\"\",\n \"title\":\"recipient\",\n \"firstname\":\"{{recipient_firstname}}\",\n \"lastname\":\"{{recipient_lastname}}\",\n \"email\":\"{{recipient_email}}\",\n \"phone\":\"\",\n \"mainaddress\":\"\",\n \"address1\":\"\",\n \"street_number\":\"\",\n \"street_address\":\"\",\n \"unitnumber\":\"\",\n \"city\":\"\",\n \"provience\":\"\",\n \"postal\":\"\",\n \"description\":\"\"\n },\n \"order\":{ \n \"title\":\"order\",\n \"active\":0,\n \"shipping_text\":\"\",\n \"tax_estimate\":\"5.07\",\n \"pre_tax_total\":0,\n \"total\":\"24.07\",\n \"gifts_total\":\"24.00\",\n \"usedcredit\":\"20.00\",\n \"shipping_cost\":\"15.00\"\n },\n \"checkout_type\":\"text_email\",\n \"gifts\":[ \n { \n \"id\": \"{{gift_id}}\",\n \"price\": \"{{gift_price}}\",\n \"total\":\"$24\",\n \"option_id\":\"{{option_id}}\",\n \"quantity\": \"{{quantity}}\"\n }\n ]\n}"},"url":"{{url}}/api/order/submit","description":"This API request is used to submit an order. Similar to the corporate view, this allows you to specify a sender, define a recipient, and define the gift ids to be sent.
\n","urlObject":{"path":["api","order","submit"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b34f2f40-0042-4c6a-bc93-ddab4c3e6245"},{"name":"Signup","id":"2bd9c72c-4d6f-44d1-92d6-2734899efb93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"username\": \"{{email_address}}\",\n\t\"password\": \"{{password}}\",\n\t\"passwor_confirm\": \"{{password_confirm}}\",\n\t\"firstname\": \"{{firstname}}\",\n\t\"lastname\": \"{{lastname}}\"\n}"},"url":"{{url}}/api/user/signup","description":"This API request is used to create/register a new user.
\n","urlObject":{"path":["api","user","signup"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2bd9c72c-4d6f-44d1-92d6-2734899efb93"},{"name":"Log Recently Viewed Item","id":"4e492fc5-51fb-4e37-a360-2a6c6790df63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \n \"gift_id\": \"{{gift_id}}\",\n \"device_id\": \"{{unique_device_id}}\",\n \"device_type\": \"{{device_type}}\",\n \"user_id\": \"{{user_token}}\",\n \"token\": \"{{user_token}}\"\n}"},"url":"{{url}}/api/log/recently-viewed","description":"This API request is used to record an item as being recently viewed. This is used to then view later using the List Recently Viewed Items.
\n","urlObject":{"path":["api","log","recently-viewed"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e492fc5-51fb-4e37-a360-2a6c6790df63"},{"name":"Retrieve Favourites","id":"e188bf65-7df3-432f-8f02-ccaed77d6b1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"device_id\": \"{{unique_device_id}}\",\n\t\"device_type\": \"{{device_type}}\",\n\t\"user_id\": \"{{user_token}}\",\n\t\"token\": \"{{user_token}}\"\n\n}"},"url":"{{url}}/api/contacts/favorites","description":"This API request is used to retrieve a list of items that have been marked favourite by a user, using the Set Favourite API call.
\n","urlObject":{"path":["api","contacts","favorites"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e188bf65-7df3-432f-8f02-ccaed77d6b1a"},{"name":"Clear Recently Viewed Items","id":"6ee0dfcb-fa20-47d9-858c-7cbca23aaf9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"device_id\": \"{{unique_device_id}}\",\n\t\"device_type\": \"{{device_type}}\",\n\t\"user_id\": \"{{user_token}}\",\n\t\"token\": \"{{user_token}}\"\n}"},"url":"{{url}}/api/clear/recently-viewed","description":"This API request clears all recently viewed items for a user. Useful in logout situations or if a user wants to clear that feature.
\n","urlObject":{"path":["api","clear","recently-viewed"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ee0dfcb-fa20-47d9-858c-7cbca23aaf9f"},{"name":"List Recently Viewed Items","id":"0b652679-33e7-415a-9662-34f59ad73ad4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"device_id\": \"{{unique_device_id}}\",\n\t\"device_type\": \"{{device_type}}\",\n\t\"user_id\": \"{{user_token}}\",\n\t\"token\": \"{{user_token}}\"\n}"},"url":"{{url}}/api/list/gifts","description":"This API request lists all the recently viewed items.
\n","urlObject":{"path":["api","list","gifts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b652679-33e7-415a-9662-34f59ad73ad4"},{"name":"Set Favourite","id":"9400e04e-9eb7-4d92-9912-ec488b745a84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \n \"is_favourite\": \"{{boolean}\",\n \"device_id\": \"{{unique_device_id}}\",\n \"device_type\": \"{{device_type}}\",\n \"user_id\": \"{{user_token}}\",\n \"token\": \"{{user_token}}\",\n \"contact_id\": \"{{contact_id}}\"\n}"},"url":"{{url}}/api/favourite/set","description":"This API request saves an item that has been marked as a favourite by a user.
\n","urlObject":{"path":["api","favourite","set"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9400e04e-9eb7-4d92-9912-ec488b745a84"},{"name":"Get Contacts","id":"a529cc06-1ddb-4738-bf57-51b3a95270eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"device_id\": \"{{unique_device_id}}\",\n \"device_type\": \"{{device_type}}\",\n \"user_id\": \"{{user_token}}\",\n \"token\": \"{{user_token}}\"\n}"},"url":"{{url}}/api/contacts/favourites/","description":"This API request returns your contacts you've marked as favourites.
\n","urlObject":{"path":["api","contacts","favourites",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a529cc06-1ddb-4738-bf57-51b3a95270eb"},{"name":"Logout (deletes token)","id":"cb5a99f5-127b-41d4-b4de-18af26d6ac67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"{{user_id}}\",\n \"token\": \"{{user_token}}\"\n}"},"url":"{{url}}/api/user/logout","description":"This API request is used to logout and user, and destroy the session.
\n","urlObject":{"path":["api","user","logout"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb5a99f5-127b-41d4-b4de-18af26d6ac67"},{"name":"GeoIP","id":"a39aec39-8398-4b9c-9cd5-7ab5e77c0d0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"url":"{{url}}/api/ip/json/{{ip}}","description":"This API request returns the Geo IP of a user, which is used to map that user to a location.
\n","urlObject":{"path":["api","ip","json","{{ip}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a39aec39-8398-4b9c-9cd5-7ab5e77c0d0e"},{"name":"Taxrate Lookup","id":"31e6b6af-c158-4c6c-8f55-443e923c526f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"gift_id\": \"{{gift_id}}\",\n\t\"zipcode\": \"{{zip_postal}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/taxrate","description":"This API request pulls the effective tax rate of a user, used during the purchase stage.
\n","urlObject":{"path":["api","taxrate"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"31e6b6af-c158-4c6c-8f55-443e923c526f"},{"name":"profile-image","id":"2f365a86-f723-42d6-b920-c81c9dfd535d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Client-Id","value":" {{client_id}}","type":"text"},{"key":"Timestamp","value":" {{request_timestamp}}","type":"text"},{"key":"Request-Hash","value":" {{generated_hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"device_id\": \"{{unique_device_id}}\",\n \"device_type\": \"{{device_type}}\",\n \"user_id\": \"{{user_token}}\",\n \"token\": \"{{user_token}}\"\n}"},"url":"{{url}}/api/user/profile-image","description":"This API request updates the user's profile image in their GG User Profile. Profile images are used within the GG Retail environment.
\n","urlObject":{"path":["api","user","profile-image"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f365a86-f723-42d6-b920-c81c9dfd535d"}]}