This API Provider is used for Shopify integration. GG provides a Shopify plugin to shop owners who want to add 'Send as Gift' to their eCommerce store and use the GG back-end to order gifts. It integrates with the Shopify API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4028164","collectionId":"10de077e-8d9b-44d3-86c6-1ca7396b3827","publishedId":"SzYW3g31","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-29T19:22:46.000Z"},"item":[{"name":"webhooks","item":[{"name":"list","id":"b2030e91-3d39-4ac5-8a9c-5b8623d754e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/shop/webhook/list/2","description":"Retrieve a list of Shopify webhooks that are subscribed to a specific Shopify account.
\n","urlObject":{"path":["shop","webhook","list","2"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2030e91-3d39-4ac5-8a9c-5b8623d754e0"},{"name":"draft_order/create","id":"56aa3bdb-f8e1-4964-a343-a67272176dd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\": 521920249907,\n\t\"note\": \"From Giftagram App\",\n\t\"email\": \"waseem@giftagram.com\",\n\t\"taxes_included\": false,\n\t\"currency\": \"CAD\",\n\t\"invoice_sent_at\": null,\n\t\"created_at\": \"2020-02-26T02:11:53-05:00\",\n\t\"updated_at\": \"2020-02-26T02:11:53-05:00\",\n\t\"tax_exempt\": false,\n\t\"completed_at\": null,\n\t\"name\": \"#D68\",\n\t\"status\": \"open\",\n\t\"line_items\": [{\n\t\t\"variant_id\": 31656580481075,\n\t\t\"product_id\": 4453925355571,\n\t\t\"title\": \"Tshirt - Feminism\",\n\t\t\"variant_title\": \"xs \\/ black\",\n\t\t\"sku\": \"100\",\n\t\t\"vendor\": \"giftagramstore\",\n\t\t\"quantity\": 1,\n\t\t\"requires_shipping\": true,\n\t\t\"taxable\": true,\n\t\t\"gift_card\": false,\n\t\t\"fulfillment_service\": \"manual\",\n\t\t\"grams\": 300,\n\t\t\"tax_lines\": [{\n\t\t\t\"rate\": 0.13,\n\t\t\t\"title\": \"HST\",\n\t\t\t\"price\": \"6.50\"\n\t\t}],\n\t\t\"applied_discount\": null,\n\t\t\"name\": \"Tshirt - Feminism - xs \\/ black\",\n\t\t\"properties\": [],\n\t\t\"custom\": false,\n\t\t\"price\": \"50.00\",\n\t\t\"admin_graphql_api_id\": \"gid:\\/\\/shopify\\/DraftOrderLineItem\\/54605603668019\"\n\t}],\n\t\"shipping_address\": null,\n\t\"billing_address\": null,\n\t\"invoice_url\": \"https:\\/\\/giftagramstore.myshopify.com\\/25726550067\\/invoices\\/91215f2c4c059030296e30d544f4a000\",\n\t\"applied_discount\": null,\n\t\"order_id\": null,\n\t\"shipping_line\": null,\n\t\"tax_lines\": [{\n\t\t\"rate\": 0.13,\n\t\t\"title\": \"HST\",\n\t\t\"price\": \"6.50\"\n\t}],\n\t\"tags\": \"Giftagram-app\",\n\t\"note_attributes\": [],\n\t\"total_price\": \"56.50\",\n\t\"subtotal_price\": \"50.00\",\n\t\"total_tax\": \"6.50\",\n\t\"admin_graphql_api_id\": \"gid:\\/\\/shopify\\/DraftOrder\\/521920249907\",\n\t\"customer\": {\n\t\t\"id\": 2886648627251,\n\t\t\"email\": \"waseem@giftagram.com\",\n\t\t\"accepts_marketing\": false,\n\t\t\"created_at\": \"2020-02-25T18:40:31-05:00\",\n\t\t\"updated_at\": \"2020-02-25T18:40:32-05:00\",\n\t\t\"first_name\": \"Waseem\",\n\t\t\"last_name\": \"Sakka\",\n\t\t\"orders_count\": 0,\n\t\t\"state\": \"enabled\",\n\t\t\"total_spent\": \"0.00\",\n\t\t\"last_order_id\": null,\n\t\t\"note\": null,\n\t\t\"verified_email\": false,\n\t\t\"multipass_identifier\": null,\n\t\t\"tax_exempt\": false,\n\t\t\"phone\": null,\n\t\t\"tags\": \"\",\n\t\t\"last_order_name\": null,\n\t\t\"currency\": \"CAD\",\n\t\t\"accepts_marketing_updated_at\": \"2020-02-25T18:40:31-05:00\",\n\t\t\"marketing_opt_in_level\": null,\n\t\t\"admin_graphql_api_id\": \"gid:\\/\\/shopify\\/Customer\\/2886648627251\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/shop/webhook/draft_orders/create","description":"Create a Draft Order.
\nShopify does not have the means to order without a shipping address selectively. As a result, GG uses draft orders to fulfill the first stage of a gift process. This stage handles the creation of a draft order.
\n","urlObject":{"path":["shop","webhook","draft_orders","create"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"56aa3bdb-f8e1-4964-a343-a67272176dd3"},{"name":"customers/data_request","id":"1609aca6-26fb-49b7-ac7e-a81cb21e05a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"HTTP_X_SHOPIFY_HMAC_SHA256","value":"1234","type":"text"}],"body":{"mode":"raw","raw":"{\"shop_id\":36123934765,\"shop_domain\":\"gguninstall.myshopify.com\",\"customer\":{\"id\":3018735845421,\"email\":\"waseem@giftagram.com\",\"phone\":\"+14167950024\"},\"orders_requested\":[]}","options":{"raw":{"language":"json"}}},"url":"{{url}}/shop/webhook/customers/data_request","urlObject":{"path":["shop","webhook","customers","data_request"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1609aca6-26fb-49b7-ac7e-a81cb21e05a9"},{"name":"draft_order/update","id":"9766132d-d3b0-4c95-a3b7-4d815494d78e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\": 521920249907,\n\t\"note\": \"From Giftagram App\",\n\t\"email\": \"waseem@giftagram.com\",\n\t\"taxes_included\": false,\n\t\"currency\": \"CAD\",\n\t\"invoice_sent_at\": null,\n\t\"created_at\": \"2020-02-26T02:11:53-05:00\",\n\t\"updated_at\": \"2020-02-26T02:11:53-05:00\",\n\t\"tax_exempt\": false,\n\t\"completed_at\": null,\n\t\"name\": \"#D68\",\n\t\"status\": \"open\",\n\t\"line_items\": [{\n\t\t\"variant_id\": 31656580481075,\n\t\t\"product_id\": 4453925355571,\n\t\t\"title\": \"Tshirt - Feminism\",\n\t\t\"variant_title\": \"xs \\/ black\",\n\t\t\"sku\": \"100\",\n\t\t\"vendor\": \"giftagramstore\",\n\t\t\"quantity\": 1,\n\t\t\"requires_shipping\": true,\n\t\t\"taxable\": true,\n\t\t\"gift_card\": false,\n\t\t\"fulfillment_service\": \"manual\",\n\t\t\"grams\": 300,\n\t\t\"tax_lines\": [{\n\t\t\t\"rate\": 0.13,\n\t\t\t\"title\": \"HST\",\n\t\t\t\"price\": \"6.50\"\n\t\t}],\n\t\t\"applied_discount\": null,\n\t\t\"name\": \"Tshirt - Feminism - xs \\/ black\",\n\t\t\"properties\": [],\n\t\t\"custom\": false,\n\t\t\"price\": \"50.00\",\n\t\t\"admin_graphql_api_id\": \"gid:\\/\\/shopify\\/DraftOrderLineItem\\/54605603668019\"\n\t}],\n\t\"shipping_address\": null,\n\t\"billing_address\": null,\n\t\"invoice_url\": \"https:\\/\\/giftagramstore.myshopify.com\\/25726550067\\/invoices\\/91215f2c4c059030296e30d544f4a000\",\n\t\"applied_discount\": null,\n\t\"order_id\": null,\n\t\"shipping_line\": null,\n\t\"tax_lines\": [{\n\t\t\"rate\": 0.13,\n\t\t\"title\": \"HST\",\n\t\t\"price\": \"6.50\"\n\t}],\n\t\"tags\": \"Giftagram-app\",\n\t\"note_attributes\": [],\n\t\"total_price\": \"56.50\",\n\t\"subtotal_price\": \"50.00\",\n\t\"total_tax\": \"6.50\",\n\t\"admin_graphql_api_id\": \"gid:\\/\\/shopify\\/DraftOrder\\/521920249907\",\n\t\"customer\": {\n\t\t\"id\": 2886648627251,\n\t\t\"email\": \"waseem@giftagram.com\",\n\t\t\"accepts_marketing\": false,\n\t\t\"created_at\": \"2020-02-25T18:40:31-05:00\",\n\t\t\"updated_at\": \"2020-02-25T18:40:32-05:00\",\n\t\t\"first_name\": \"Waseem\",\n\t\t\"last_name\": \"Sakka\",\n\t\t\"orders_count\": 0,\n\t\t\"state\": \"enabled\",\n\t\t\"total_spent\": \"0.00\",\n\t\t\"last_order_id\": null,\n\t\t\"note\": null,\n\t\t\"verified_email\": false,\n\t\t\"multipass_identifier\": null,\n\t\t\"tax_exempt\": false,\n\t\t\"phone\": null,\n\t\t\"tags\": \"\",\n\t\t\"last_order_name\": null,\n\t\t\"currency\": \"CAD\",\n\t\t\"accepts_marketing_updated_at\": \"2020-02-25T18:40:31-05:00\",\n\t\t\"marketing_opt_in_level\": null,\n\t\t\"admin_graphql_api_id\": \"gid:\\/\\/shopify\\/Customer\\/2886648627251\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/shop/webhook/draft_orders/create","description":"This webhook is subscribed to Shopify and updates draft order statuses.
\n","urlObject":{"path":["shop","webhook","draft_orders","create"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9766132d-d3b0-4c95-a3b7-4d815494d78e"},{"name":"subscribe","id":"9ca8a111-555a-4750-b8d8-8059a6482614","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/shop/webhook/subscribe/2","description":"This API subscribes webhooks during plugin installation.
\n","urlObject":{"path":["shop","webhook","subscribe","2"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ca8a111-555a-4750-b8d8-8059a6482614"},{"name":"clear","id":"3a2cdb4b-3120-4e62-a6d5-4ec803fa6ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/shop/webhook/clear/2","description":"This API request clears the subscribed webhooks for a Shopify account.
\n","urlObject":{"path":["shop","webhook","clear","2"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a2cdb4b-3120-4e62-a6d5-4ec803fa6ad5"}],"id":"e238a0f0-f3ed-49ff-9a8c-7ac3079c19a2","_postman_id":"e238a0f0-f3ed-49ff-9a8c-7ac3079c19a2","description":""},{"name":"Shopify Widget OAuth Initialization","id":"df2ec6c6-1723-4293-800e-2e047478c340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"shop\": \"giftagramstore.myshopify.com\"\n}"},"url":"{{url}}/shop/admin/","description":"This API request handles OAuth initialization to Shopify during plugin installation.
\n","urlObject":{"path":["shop","admin",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"df2ec6c6-1723-4293-800e-2e047478c340"},{"name":"Shopify Widget OAuth Callback","id":"14c07264-2903-4462-9cc2-b0d716a84f7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/shop/admin/app-callback?code={{oauth_code}}&hmac={{hmac}}&shop={{domain}}&state={{state}}×tamp={{timestamp}}","description":"Callback for the Shopify OAuth request.
\n","urlObject":{"path":["shop","admin","app-callback"],"host":["{{url}}"],"query":[{"key":"code","value":"{{oauth_code}}"},{"key":"hmac","value":"{{hmac}}"},{"key":"shop","value":"{{domain}}"},{"key":"state","value":"{{state}}"},{"key":"timestamp","value":"{{timestamp}}"}],"variable":[]}},"response":[],"_postman_id":"14c07264-2903-4462-9cc2-b0d716a84f7d"},{"name":"Shopify Widget Store Info","id":"633ac46c-a378-4a48-aa97-e4e75f8055ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Shopify-Store-Domain","type":"text","value":"{{domain}}"}],"url":"{{url}}/shop/info","description":"This API request retrieves a Shopify Widget's store information.
\n","urlObject":{"path":["shop","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"633ac46c-a378-4a48-aa97-e4e75f8055ea"},{"name":"Shopify Widget Order Occasions","id":"95c2a951-ce0e-4543-b66c-baa94fc06eab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/shop/order/occasions","description":"This API retrieves order occasions from Shopify.
\n","urlObject":{"path":["shop","order","occasions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"95c2a951-ce0e-4543-b66c-baa94fc06eab"},{"name":"Shopify Widget Order Place","id":"d4ad8764-14a8-4121-a7bb-caad00bacc1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Shopify-Store-Domain","type":"text","value":"{{domain}}"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"product_id\": \"{{product_id}}\",\n \"variant_id\": \"{{variant_id}}\",\n \"quantity\": 1\n }\n ],\n \"recipient\": {\n \"name\": \"{{recipient_full_name}}\"\n },\n \"occasion_id\": \"{{occasion_id}}\",\n \"gift_message\": \"{{personal_gift_message}}\",\n \"sender\": {\n \"name\": \"{{sender_full_name}}\",\n \"email\": \"{{email_address}}\",\n \"phone_number\": \"{{phone_number}}\"\n }\n}"},"url":"{{url}}/shop/order/place","description":"This API call places an order with Giftagram. It uses Shopify's product IDS and variants when placing the order.
\n","urlObject":{"path":["shop","order","place"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4ad8764-14a8-4121-a7bb-caad00bacc1a"},{"name":"Shopify Widget Email Recipient The Gift Link","id":"6e4f6770-d0bf-4713-b18f-446b5b32669d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"widget_order_id\": \"{{order_id}}\",\n \"recipient_email\": \"{{recipient_email}}\"\n}"},"url":"{{url}}/shop/order/email-the-gift-link","description":"This API request emails the gifting link to the recipient to accept a gift.
\n","urlObject":{"path":["shop","order","email-the-gift-link"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e4f6770-d0bf-4713-b18f-446b5b32669d"},{"name":"Shopify Widget Recipient Landing Page","id":"496e5791-d65f-423f-8cb6-7eda3fad92d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/shop/order/confirm/{{order_hash}}","description":"This API request is used to present the landing page to a recipient based on the order_hash.
\n","urlObject":{"path":["shop","order","confirm","{{order_hash}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"496e5791-d65f-423f-8cb6-7eda3fad92d1"},{"name":"Shopify Widget Recipient Landing Page Confirm","id":"10d0a4cb-e4c6-4feb-a51b-4db24537b196","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"widget_order_id\": 1,\n \"items\": [\n {\n \"product_id\": \"{{product_id}}\",\n \"variant_id\": \"{{variant_id}}\"\n }\n ],\n \"recipient_address\": {\n \"name\": \"{{recipient_fullname}}\",\n \"address1\": \"{{recipient_address}}\",\n \"address2\": \"{{recipient_address2}}\",\n \"city\": \"{{recipient_city}}\",\n \"province\": \"{{recipient_province}}\",\n \"country\": \"{{recipient_country}}\",\n \"zip_code\": \"{{recipient_zippostal}}\",\n \"phone_number\": \"{{recipient_phone}}\"\n },\n \"thank_you_note\": \"{{note}}\"\n}"},"url":"{{url}}/shop/order/confirm","description":"This API request is used to confirm acceptance of a gift by a recipient.
\n","urlObject":{"path":["shop","order","confirm"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"10d0a4cb-e4c6-4feb-a51b-4db24537b196"},{"name":"Shopify Widget Script Tag","id":"28e3dd62-d42d-42a5-a3c5-25b2ff0580c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Shopify-Store-Domain","type":"text","value":"{{domain}}"}],"body":{"mode":"raw","raw":"{\n \"shop_id\": \"{{shop_id}}\",\n \"tag\": \"{{boolean}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/shop/admin/script-tag","description":"API request turns the CSS and JS rendered for a specific shopify store. This is to permit customization against a shop's specific theme.
\n","urlObject":{"path":["shop","admin","script-tag"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"28e3dd62-d42d-42a5-a3c5-25b2ff0580c3"},{"name":"Shopify Widget Product Info","id":"93085f84-a634-4954-acc3-b0d51b7dc5e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Shopify-Store-Domain","type":"text","value":"giftagramstore.myshopify.com"}],"url":"{{url}}/shop/product/product-info/{{product_id}}","description":"This API request retrieves product information from Shopify (acts as a proxy).
\n","urlObject":{"path":["shop","product","product-info","{{product_id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"93085f84-a634-4954-acc3-b0d51b7dc5e5"}]}