For additional information and guides, visit https://develop.yotpo.com/docs/welcome
\nFor full API documentation, visit https://develop.yotpo.com/reference/getting-started-1
\nIf you need further assistance, contact us at apps@yotpo.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32783633","collectionId":"52e4f1b9-589e-4259-9e30-71dc1f8903c9","publishedId":"2sAXjJ6DR1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-10T10:33:17.000Z"},"item":[{"name":"Authentication and App","item":[{"name":"Generate Access Token","id":"12569413-af7b-41b4-8257-acaa4c428e21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"redirect_uri\": \"{{redirect_uri}}\",\n \"code\": \"{{oauth_code}}\"\n}"},"url":"https://developers.yotpo.com/v2/oauth2/token","description":"Use this endpoint to generate an access_token using your OAuth 2.0 code.
\n","urlObject":{"protocol":"https","path":["v2","oauth2","token"],"host":["developers","yotpo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"12569413-af7b-41b4-8257-acaa4c428e21"},{"name":"Remove Application","id":"370a1240-b72f-478e-99bc-83be6b7eae63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/access_tokens/{{access_token}}","description":"Use this endpoint to delete an existing access token and remove authorization to the Yotpo account. We recommend you use this call each time you uninstall an app. Once confirmed, this operation cannot be undone.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","access_tokens","{{access_token}}"],"host":["developers","yotpo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"370a1240-b72f-478e-99bc-83be6b7eae63"}],"id":"7a8c69ae-d66f-47ab-9da8-73e073c492b9","_postman_id":"7a8c69ae-d66f-47ab-9da8-73e073c492b9","description":""},{"name":"Orders and Fulfillments","item":[{"name":"Retrieve Orders","id":"5ce54186-c3dd-451d-8804-adf9f72d0332","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/orders?access_token={{access_token}}","description":"Retrieve a list of all available orders. This endpoint supports pagination and filtering by external IDs and date range.
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","orders"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"disabled":true,"key":"page_info","value":"{{page_info}}"},{"disabled":true,"key":"limit","value":"100"},{"disabled":true,"key":"external_ids","value":"{{external_ids}}"},{"disabled":true,"key":"order_date_min","value":"{{order_date_min}}"},{"disabled":true,"key":"order_date_max","value":"{{order_date_max}}"}],"variable":[]}},"response":[],"_postman_id":"5ce54186-c3dd-451d-8804-adf9f72d0332"},{"name":"Retrieve Order Fulfillments","id":"4e8bd130-40aa-4702-92ef-afb51263e338","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/orders/{{yotpo_order_id}}/fulfillments?access_token={{access_token}}","description":"Retrieve a list of fulfillments for an order.
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","orders","{{yotpo_order_id}}","fulfillments"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"disabled":true,"key":"page_info","value":"{{page_info}}"},{"disabled":true,"key":"limit","value":"{{limit}}"},{"disabled":true,"key":"external_ids","value":"{{external_ids}}"}],"variable":[]}},"response":[],"_postman_id":"4e8bd130-40aa-4702-92ef-afb51263e338"},{"name":"Update Order Fulfillment","id":"6e5aa60d-e607-4947-998c-5cb4c1a746f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fulfillment\": {\n \"external_id\": \"string\",\n \"fulfillment_date\": \"2022-12-06T15:48:22\",\n \"status\": \"success\",\n \"shipment_info\": {\n \"shipment_status\": \"delivered\",\n \"tracking_company\": \"DHL\",\n \"tracking_url\": \"https://www.dhl.com/us-en/home/tracking.html\",\n \"tracking_number\": \"6827231234\"\n },\n \"fulfilled_items\": [\n {\n \"external_product_id\": \"911\",\n \"quantity\": 1\n }\n ]\n }\n}"},"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/orders/{{yotpo_order_id}}/fulfillments/{{yotpo_fulfillment_id}}?access_token={{access_token}}","description":"Update an order fulfillment. Note: It is not necessary to use this endpoint for status updates received already in the e-commerce platform.
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","orders","{{yotpo_order_id}}","fulfillments","{{yotpo_fulfillment_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"6e5aa60d-e607-4947-998c-5cb4c1a746f5"}],"id":"e54c07fe-9cdb-4ad4-92fc-fd62573a9a11","_postman_id":"e54c07fe-9cdb-4ad4-92fc-fd62573a9a11","description":""},{"name":"Products","item":[{"name":"Product Data","id":"541ad06f-ba5c-4c08-87b8-4d585ab3989a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/products/{{external_product_id}}?access_token={{access_token}}","description":"Retrieve product data by product_id. This call returns product data such as product identifiers, average score, total review count, and more.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","products","{{external_product_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"541ad06f-ba5c-4c08-87b8-4d585ab3989a"},{"name":"Promoted Products","id":"bcd5b6f1-0e22-4e93-9e4a-8dfcf31b85ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/promoted_products?access_token={{access_token}}","description":"Retrieve Yotpo's automatically promoted popular products based on purchase date, star rating, number of reviews, and manually selected products.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","promoted_products"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"bcd5b6f1-0e22-4e93-9e4a-8dfcf31b85ef"},{"name":"Retrieve Products","id":"b73f1b8c-e5af-4256-8857-600267194979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/products?access_token={{access_token}}","description":"Retrieves a list of all of the store's products. You can use this endpoint to resolve the Yotpo product ID in order to update it.
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","products"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"disabled":true,"key":"limit","value":"{{limit}}"},{"disabled":true,"key":"page_info","value":"{{page_info}}"},{"disabled":true,"key":"external_ids","value":"{{external_ids}}"}],"variable":[]}},"response":[],"_postman_id":"b73f1b8c-e5af-4256-8857-600267194979"}],"id":"aa66f12c-9b52-422e-a4cf-3db03ebe3feb","_postman_id":"aa66f12c-9b52-422e-a4cf-3db03ebe3feb","description":""},{"name":"Reviews","item":[{"name":"All Reviews","id":"a32a52a5-a44c-4621-8480-a072e89c27a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/reviews?access_token={{access_token}}","description":"Retrieve reviews data per account as a paginated response. Returns reviews metrics such as review id, star-ratings score, votes_up or votes_down, review content, product identifiers, and more.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","reviews"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"disabled":true,"key":"include_nested","value":"{{include_nested}}"},{"disabled":true,"key":"include_site_reviews","value":"{{include_site_reviews}}"},{"disabled":true,"key":"count","value":"{{count}}"},{"disabled":true,"key":"page","value":"{{page}}"},{"disabled":true,"key":"sort","value":"{{sort}}"},{"disabled":true,"key":"direction","value":"{{direction}}"},{"disabled":true,"key":"star","value":"{{star}}"},{"disabled":true,"key":"include_unpublished_reviews","value":"{{include_unpublished_reviews}}"},{"disabled":true,"key":"created_at_min","value":"{{created_at_min}}"},{"disabled":true,"key":"updated_at_min","value":"{{updated_at_min}}"},{"disabled":true,"key":"customer_email","value":"{{customer_email}}"}],"variable":[]}},"response":[],"_postman_id":"a32a52a5-a44c-4621-8480-a072e89c27a9"},{"name":"Product Reviews","id":"a47b54ad-cf3b-4dff-93ee-4846fd19db7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/products/{{external_product_id}}/reviews?access_token={{access_token}}","description":"Retrieve product reviews for a specific product using the external_product_id.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","products","{{external_product_id}}","reviews"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"disabled":true,"key":"page","value":"{{page}}"},{"disabled":true,"key":"count","value":"{{count}}"},{"disabled":true,"key":"star","value":"{{star}}"},{"disabled":true,"key":"include_unpublished_reviews","value":"{{include_unpublished_reviews}}"}],"variable":[]}},"response":[],"_postman_id":"a47b54ad-cf3b-4dff-93ee-4846fd19db7a"},{"name":"Product Star Rating","id":"4f9eca43-3fff-44ea-85fd-6a7610812609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/star_rating/products/{{external_product_id}}?access_token={{access_token}}","description":"Retrieve the average star-rating and review count for a specific product by external_product_id.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","star_rating","products","{{external_product_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"4f9eca43-3fff-44ea-85fd-6a7610812609"},{"name":"Get Review by ID","id":"56d83129-b5fb-4b36-a9b9-75881b305595","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/reviews/:review_id?access_token={{access_token}}&include_nested={{include_nested}}&include_site_reviews={{include_site_reviews}}&include_unpublished_reviews={{include_unpublished_reviews}}","description":"Retrieve a specific review by review_id.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","reviews",":review_id"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"key":"include_nested","value":"{{include_nested}}"},{"key":"include_site_reviews","value":"{{include_site_reviews}}"},{"key":"include_unpublished_reviews","value":"{{include_unpublished_reviews}}"}],"variable":[{"description":{"content":"The review_id. Can be found using All Reviews
\n","type":"text/plain"},"type":"any","value":"{{review_id}}","key":"review_id"}]}},"response":[],"_postman_id":"56d83129-b5fb-4b36-a9b9-75881b305595"},{"name":"Get Top Reviews","id":"08edb1d8-1838-43ca-ad4c-25fc6a35e9ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/top_reviews?access_token={{access_token}}&external_product_id={{external_product_id}}","description":"This endpoint automatically retrieves the top reviews from your Yotpo reviews based on the star rating. It's recommended as a fallback to the best reviews endpoint in languages other than English.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","top_reviews"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"description":{"content":"The product ID you want to retrieve data for. If not provided, this endpoint would fetch site reviews.
\n","type":"text/plain"},"key":"external_product_id","value":"{{external_product_id}}"}],"variable":[]}},"response":[],"_postman_id":"08edb1d8-1838-43ca-ad4c-25fc6a35e9ce"},{"name":"Get Best Reviews","id":"9fcda7e3-1a6a-4ff6-ac7e-181e2e3c0f0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"minimum_review_length\": 150,\n \"maximum_review_length\": 500,\n \"minimum_title_length\": 20,\n \"maximum_title_length\": 100,\n \"start_date\": \"2017-01-13T00:00:00.000Z\",\n \"end_date\": \"2018-05-13T00:00:00.000Z\",\n \"max_reviews\": 10,\n \"minimum_score\": 4,\n \"exclude_unpublished\": true,\n \"exclude_syndicated\": false,\n \"exclude_negative_opinions\": true,\n \"exclude_grouped_reviews\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/v2/{{store_id}}/best_reviews?access_token={{access_token}}","description":"Leveraging Yotpo's Insights engine, 'Best reviews' are identified, parsed, and extracted based on the number of distinct positive topics and opinions within your reviews. This endpoint supports English reviews only.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","best_reviews"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"9fcda7e3-1a6a-4ff6-ac7e-181e2e3c0f0b"},{"name":"Get Best Sentences","id":"f595f63e-17af-4b1c-af15-1511599f7890","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"minimum_sentence_length\": 20,\n \"maximum_sentence_length\": 100,\n \"maximum_number_of_sentences\": 3,\n \"start_date\": \"2017-01-13T00:00:00.000Z\",\n \"end_date\": \"2018-05-13T00:00:00.000Z\",\n \"minimum_score\": 4,\n \"exclude_unpublished\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/v2/{{store_id}}/best_sentences?access_token={{access_token}}","description":"This endpoint automatically retrieves the very best sentences from your Yotpo reviews, so you can leverage the social proof of top customer testimonials at key conversion points throughout the buyer journey!
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","best_sentences"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"f595f63e-17af-4b1c-af15-1511599f7890"}],"id":"a66466aa-7271-4352-b188-5abe1d0fc868","_postman_id":"a66466aa-7271-4352-b188-5abe1d0fc868","description":""},{"name":"Customers","item":[{"name":"Create or Update Customer","id":"aa7de498-79e6-40da-be1e-67a5dda9b301","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"email\": \"tom.smith@hostname.com\",\n \"first_name\": \"Tom\",\n \"last_name\": \"Smith\",\n \"gender\": \"M\",\n \"account_created_at\": \"2023-09-08T09:43:27Z\",\n \"account_status\": \"enabled\",\n \"default_language\": \"en\",\n \"default_currency\": \"USD\",\n \"tags\": \"vipgold,loyal\",\n \"address\": {\n \"address1\": \"96 Coffee Street\",\n \"address2\": \"\",\n \"city\": \"Hudson\",\n \"company\": \"null\",\n \"state\": \"New York\",\n \"zip\": \"13420\",\n \"province_code\": \"NY\",\n \"country_code\": \"US\",\n \"phone_number\": \"+5556251199\"\n },\n \"custom_properties\": {\n \"hair_type\": \"wavy\",\n \"skin_type\": \"dry\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/customers?access_token={{access_token}}","description":"Create or update a customer in the Yotpo platform
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","customers"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"aa7de498-79e6-40da-be1e-67a5dda9b301"},{"name":"Create or Update Custom Customer Event","id":"03497f8c-0f2f-40f0-805f-c6b93d1b1101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_event\": {\n \"event_source\": \"quizapp\",\n \"event_type\": \"order_shipped\",\n \"event_time\": \"2022-12-10T10:15:44.716Z\",\n \"external_event_id\": \"37fb87a9-6cfd-4983-bd75-68d104d53b70\",\n \"customer\": {\n \"email\": \"jane.doe@example.com\",\n \"custom_properties\": {\n \"skin_type\": \"oily\",\n \"age\": 42\n }\n },\n \"event_properties\": {\n \"order_status_url\": \"example.com/orderstatus/543211\",\n \"delivery_date\": \"December 10\",\n \"order_id\": \"543211\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/customer_events?access_token={{access_token}}","description":"Create or update a custom customer event in the Yotpo platform
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","customer_events"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"62aaed96-b4f0-454f-ba47-7b7cdd67c68b","name":"Dynamic Products Block","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_event\": {\n \"event_source\": \"my_app\",\n \"event_type\": \"order_placed\",\n \"event_time\": \"2022-12-10T10:15:44.716Z\",\n \"external_event_id\": \"37fb87a9-6cfd-4983-bd75-68d104d53b70\",\n \"customer\": {\n \"email\": \"jane.doe@example.com\",\n \"custom_properties\": {\n \"collection\": \"woman_dresses\"\n }\n },\n \"event_properties\": {\n \"email_product_block_ids\": \"8345630966076, 8345630933308\",\n \"Reorder_landing_page_url\": \"https://example-brand.com/apps/my_app/reorder?shopify_order_id={{shopify_order_id}}\",\n \"product_url\": \"brand.com/product-name/prd/202911738?colourWayId=202911741&cid=2639\",\n \"product_name\": \"product name\",\n \"brand\": \"SOMEBRAND\",\n \"product_price\": 225.0,\n \"product_compare_at_price\": 250.0\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/customer_events?access_token={{access_token}}","protocol":"https","host":["developers","yotpo","com"],"path":["core","v3","stores","{{store_id}}","customer_events"],"query":[{"key":"access_token","value":"{{access_token}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"03497f8c-0f2f-40f0-805f-c6b93d1b1101"},{"name":"Retrieve Customers","id":"c27a2a53-75ab-4654-8d82-31c41b85b25e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/customers?access_token={{access_token}}","description":"Retrieve a list of past and existing customers as they appear in Yotpo
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","customers"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"disabled":true,"key":"page_info","value":"{{page_info}}"},{"disabled":true,"key":"limit","value":"{{limit}}"},{"disabled":true,"key":"external_ids","value":"{{external_ids}}"},{"disabled":true,"key":"include_custom_properties","value":"{{include_custom_properties}}"},{"disabled":true,"key":"expand","value":"{{expand}}"},{"disabled":true,"key":"email","value":"{{email}}"},{"disabled":true,"key":"phone_number","value":"{{phone_number}}"},{"disabled":true,"key":"updated_at_min","value":"{{updated_at_min}}"},{"disabled":true,"key":"list_ids","value":"{{list_ids}}"},{"disabled":true,"key":"segment_id","value":"{{segment_id}}"}],"variable":[]}},"response":[],"_postman_id":"c27a2a53-75ab-4654-8d82-31c41b85b25e"},{"name":"Retrieve Loyalty Customer Details by Email","id":"e9310d0e-0c32-415e-b0fa-f86be0600128","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customers\": {\n \"customer_email\": \"tom.smith@hostname.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/loyalty/v3/stores/{{store_id}}/customers?access_token={{access_token}}","description":"Retrieve a customer record from Yotpo Loyalty & Referrals (updated in real-time)
\n","urlObject":{"protocol":"https","path":["loyalty","v3","stores","{{store_id}}","customers"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"e9310d0e-0c32-415e-b0fa-f86be0600128"}],"id":"dff22c35-9b41-4bab-bb49-041263119e0e","_postman_id":"dff22c35-9b41-4bab-bb49-041263119e0e","description":""},{"name":"Audience Management","item":[{"name":"Create or Update Subscriber","id":"edb86c9f-f81e-4e50-80fe-91446b3731a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"email\": \"janedoe@example.com\",\n \"phone\": \"+12025550333\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n },\n \"channels\": {\n \"sms\": {\n \"marketing\": {\n \"consent\": \"subscribed\",\n \"list_id\": \"3988660\",\n \"source\": \"post_purchase_popup\"\n }\n },\n \"email\": {\n \"marketing\": {\n \"consent\": \"subscribed\",\n \"list_id\": \"3988660\",\n \"source\": \"post_purchase_popup\"\n }\n },\n \"suppress_welcome_messages\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/messaging/v3/stores/{{store_id}}/subscribers?access_token={{access_token}}","description":"Sync subscribers from any subscription collection tool, for example, a third-party subscription popup
\n","urlObject":{"protocol":"https","path":["messaging","v3","stores","{{store_id}}","subscribers"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"789662ea-04cd-475b-8a8a-2d617f632874","name":"Unsubscribe Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"email\": \"janedoe@example.com\",\n \"phone\": \"+12025550333\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n },\n \"channels\": {\n \"sms\": {\n \"marketing\": {\n \"consent\": \"unsubscribed\",\n \"list_id\": \"3988660\",\n \"source\": \"post_purchase_popup\"\n }\n },\n \"email\": {\n \"marketing\": {\n \"consent\": \"unsubscribed\",\n \"list_id\": \"3988660\",\n \"source\": \"post_purchase_popup\"\n }\n },\n \"suppress_welcome_messages\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://developers.yotpo.com/messaging/v3/stores/{{store_id}}/subscribers?access_token={{access_token}}","protocol":"https","host":["developers","yotpo","com"],"path":["messaging","v3","stores","{{store_id}}","subscribers"],"query":[{"key":"access_token","value":"{{access_token}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""},{"id":"91d449b1-537d-4b70-8f2a-bb5af5830a4e","name":"Delete Customer Consent","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"email\": \"janedoe@example.com\",\n \"phone\": \"+12025550333\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n },\n \"channels\": {\n \"sms\": {\n \"marketing\": {\n \"consent\": null\n }\n },\n \"email\": {\n \"marketing\": {\n \"consent\": null\n }\n },\n \"suppress_welcome_messages\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://developers.yotpo.com/messaging/v3/stores/{{store_id}}/subscribers?access_token={{access_token}}","protocol":"https","host":["developers","yotpo","com"],"path":["messaging","v3","stores","{{store_id}}","subscribers"],"query":[{"key":"access_token","value":"{{access_token}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"d30f64cb-c032-413c-adf4-d82544e67d4f","name":"Create or Update Subscriber","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"email\": \"janedoe@example.com\",\n \"phone\": \"+12025550333\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n },\n \"channels\": {\n \"sms\": {\n \"marketing\": {\n \"consent\": \"subscribed\",\n \"list_id\": \"3988660\",\n \"source\": \"post_purchase_popup\"\n }\n },\n \"email\": {\n \"marketing\": {\n \"consent\": \"subscribed\",\n \"list_id\": \"3988660\",\n \"source\": \"post_purchase_popup\"\n }\n },\n \"suppress_welcome_messages\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://developers.yotpo.com/messaging/v3/stores/{{store_id}}/subscribers?access_token={{access_token}}","protocol":"https","host":["developers","yotpo","com"],"path":["messaging","v3","stores","{{store_id}}","subscribers"],"query":[{"key":"access_token","value":"{{access_token}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"edb86c9f-f81e-4e50-80fe-91446b3731a0"},{"name":"Get Lists","id":"53c1cf77-c31a-4e5e-8175-1762cf2259c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/lists?access_token={{access_token}}&page={{page}}&page_size={{page_size}}","description":"Get a list of all existing Yotpo SMS & Email Lists
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","lists"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"key":"page","value":"{{page}}"},{"key":"page_size","value":"{{page_size}}"}],"variable":[]}},"response":[],"_postman_id":"53c1cf77-c31a-4e5e-8175-1762cf2259c4"},{"name":"Create List","id":"27fb0f95-4fc0-4940-9873-54415fa84881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"list\": {\n \"name\": \"Newsletter\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/lists","description":"Use this endpoint to create a new List in Yotpo SMS & Email
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","lists"],"host":["developers","yotpo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"27fb0f95-4fc0-4940-9873-54415fa84881"},{"name":"Add contacts to List","id":"8b7602f1-b9db-4da4-b3f3-d423bd08457d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"email\": \"example@yotpo.com\"\n },\n {\n \"phone_number\": \"+14155552671\"\n },\n {\n \"email\": \"tom.smith@hostname.com\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/lists/{{list_id}}/add-contacts","description":"Add specific contacts to an existing List
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","lists","{{list_id}}","add-contacts"],"host":["developers","yotpo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8b7602f1-b9db-4da4-b3f3-d423bd08457d"},{"name":"Remove contacts from List","id":"772fd657-6fe5-48f1-8e18-22168cd195d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"email\": \"example@yotpo.com\"\n },\n {\n \"phone_number\": \"+14155552671\"\n },\n {\n \"email\": \"tom.smith@hostname.com\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/stores/{{store_id}}/lists/{{list_id}}/remove-contacts","description":"Remove specific contacts from an existing List
\n","urlObject":{"protocol":"https","path":["core","v3","stores","{{store_id}}","lists","{{list_id}}","remove-contacts"],"host":["developers","yotpo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"772fd657-6fe5-48f1-8e18-22168cd195d3"}],"id":"1dc8113e-5565-4dda-afbf-ab70d3a9dc61","_postman_id":"1dc8113e-5565-4dda-afbf-ab70d3a9dc61","description":""},{"name":"SMS & Email Analytics APIs","item":[{"name":"Explore","item":[{"name":"Dimensions","id":"62f2d411-72fb-45cf-bbc2-081e2dbdd4f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Cookie","value":"csrfToken=A%2FSEEd7pWNY8LPpf3FAGPzNhMWM1ODEyZTdiYzNiMDNiZmNhNzBkYmYwNDczZjFkMWYxNjFiNWE%3D"}],"url":"https://developers.yotpo.com/messaging/v3/stores/vzUcKDzVhizs3UE2qDWhvpsfkFPlfjj5XIfGsy9a/analytics/explore/dimensions?access_token={{access_token}}","description":"Generated from cURL: curl --location --globoff 'https://developers.yotpo.com/messaging/v3/stores/vzUcKDzVhizs3UE2qDWhvpsfkFPlfjj5XIfGsy9a/analytics/explore/dimensions?access_token=aKAJ8bEdz0jfNmQy3Undt6hLq1t2v1VN&filters[]=source_type%3Dcampaign&dimensions[]=channel_type&dimensions[]=source_type&dimensions[]=source_name&dimensions[]=source_id&dimensions[]=aggregation_date&measures[]=all_sent&measures[]=all_delivered&measures[]=all_open&measures[]=all_unique_open&measures[]=opened_delivered_rate&measures[]=unique_opened_delivered_rate&measures[]=all_clicks&measures[]=all_unique_clicks&measures[]=click_through_rate&measures[]=unique_click_through_rate&measures[]=all_orders&measures[]=all_revenue&measures[]=all_unsubscribed&measures[]=unsubscribe_rate&measures[]=average_order_value'
--header 'accept: application/json'
--header 'Cookie: csrfToken=A%2FSEEd7pWNY8LPpf3FAGPzNhMWM1ODEyZTdiYzNiMDNiZmNhNzBkYmYwNDczZjFkMWYxNjFiNWE%3D'
Generated from cURL: curl --location --globoff 'https://developers.yotpo.com/messaging/v3/stores/vzUcKDzVhizs3UE2qDWhvpsfkFPlfjj5XIfGsy9a/analytics/explore/measures?access_token=aKAJ8bEdz0jfNmQy3Undt6hLq1t2v1VN&filters[]=source_type%3Dcampaign&dimensions[]=channel_type&dimensions[]=source_type&dimensions[]=source_name&dimensions[]=source_id&dimensions[]=aggregation_date&measures[]=all_sent&measures[]=all_delivered&measures[]=all_open&measures[]=all_unique_open&measures[]=opened_delivered_rate&measures[]=unique_opened_delivered_rate&measures[]=all_clicks&measures[]=all_unique_clicks&measures[]=click_through_rate&measures[]=unique_click_through_rate&measures[]=all_orders&measures[]=all_revenue&measures[]=all_unsubscribed&measures[]=unsubscribe_rate&measures[]=average_order_value'
--header 'accept: application/json'
--header 'Cookie: csrfToken=A%2FSEEd7pWNY8LPpf3FAGPzNhMWM1ODEyZTdiYzNiMDNiZmNhNzBkYmYwNDczZjFkMWYxNjFiNWE%3D'
Retrieve all SMS and email campaigns per account
\n","urlObject":{"protocol":"https","path":["messaging","v3","stores","{{store_id}}","analytics","source","campaigns"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"032ab8a2-b958-4b8e-a439-33256db0f999"},{"name":"Automations","id":"33e5483c-6c21-48ed-a5a3-d0d099b867f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://developers.yotpo.com/messaging/v3/stores/{{store_id}}/analytics/source/automations?access_token={{access_token}}","description":"Retrieve all SMS and email automations per account
\n","urlObject":{"protocol":"https","path":["messaging","v3","stores","{{store_id}}","analytics","source","automations"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"33e5483c-6c21-48ed-a5a3-d0d099b867f5"},{"name":"Flows","id":"c85ac072-9a96-445e-9337-22a4f2970bb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://developers.yotpo.com/messaging/v3/stores/{{store_id}}/analytics/source/flows?access_token={{access_token}}","description":"Retrieve all SMS and email flows per account
\n","urlObject":{"protocol":"https","path":["messaging","v3","stores","{{store_id}}","analytics","source","flows"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"c85ac072-9a96-445e-9337-22a4f2970bb3"}],"id":"185d7e1c-cb6c-418a-96d8-6767cfbe14c3","_postman_id":"185d7e1c-cb6c-418a-96d8-6767cfbe14c3","description":""},{"name":"Get Aggregations","id":"c3415dad-710d-4f47-baaf-87423f1b1751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"}],"url":"https://developers.yotpo.com/messaging/v3/stores/{{store_id}}/analytics/query/aggregations?access_token={{access_token}}","description":"Aggregate data based on dimensions and measures from a specified source such as campaigns or flows.
\n","urlObject":{"protocol":"https","path":["messaging","v3","stores","{{store_id}}","analytics","query","aggregations"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"disabled":true,"key":"filters[]","value":"source_type=campaign"},{"disabled":true,"key":"dimensions[]","value":"channel_type"},{"disabled":true,"key":"dimensions[]","value":"source_type"},{"disabled":true,"key":"dimensions[]","value":"source_name"},{"disabled":true,"key":"dimensions[]","value":"source_id"},{"disabled":true,"key":"dimensions[]","value":"aggregation_date"},{"disabled":true,"key":"measures[]","value":"all_sent"},{"disabled":true,"key":"measures[]","value":"all_delivered"},{"disabled":true,"key":"measures[]","value":"all_open"},{"disabled":true,"key":"measures[]","value":"all_unique_open"},{"disabled":true,"key":"measures[]","value":"opened_delivered_rate"},{"disabled":true,"key":"measures[]","value":"unique_opened_delivered_rate"},{"disabled":true,"key":"measures[]","value":"all_clicks"},{"disabled":true,"key":"measures[]","value":"all_unique_clicks"},{"disabled":true,"key":"measures[]","value":"click_through_rate"},{"disabled":true,"key":"measures[]","value":"unique_click_through_rate"},{"disabled":true,"key":"measures[]","value":"all_orders"},{"disabled":true,"key":"measures[]","value":"all_revenue"},{"disabled":true,"key":"measures[]","value":"all_unsubscribed"},{"disabled":true,"key":"measures[]","value":"unsubscribe_rate"},{"disabled":true,"key":"measures[]","value":"average_order_value"},{"disabled":true,"key":"sort[]","value":null}],"variable":[]}},"response":[],"_postman_id":"c3415dad-710d-4f47-baaf-87423f1b1751"}],"id":"2c718f6c-a641-4789-be55-102265714f41","_postman_id":"2c718f6c-a641-4789-be55-102265714f41","description":""},{"name":"Loyalty & Referrals","item":[{"name":"Adjust Loyalty Customer Points","id":"fd0c26ed-a9fd-47e8-8a97-4ddda23dd10d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"points\": {\n \"customer_email\": \"tom.smith@hostname.com\",\n \"history_title\": \"Campaign type name\",\n \"point_adjustment_amount\": -10,\n \"visible_to_customer\": true,\n \"apply_adjustment_to_points_earned\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/loyalty/v3/stores/{{store_id}}/points/adjust?access_token={{access_token}}","description":"Adjust a customer's loyalty points. Can be used to add or remove points.
\n","urlObject":{"protocol":"https","path":["loyalty","v3","stores","{{store_id}}","points","adjust"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"fd0c26ed-a9fd-47e8-8a97-4ddda23dd10d"},{"name":"Record Loyalty Customer Action","id":"29667087-ff4b-4892-b914-346d40c06540","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"custom_actions\": {\n \"type\": \"custom_action\",\n \"customer_email\": \"zamirmaya@gmail.com\",\n \"action_name\": \"ShoppingGives\",\n \"ip_address\": \"127.0.0.1\",\n \"created_at\": \"2022-08-03T09:41:13.000Z\",\n \"history_title\": \"donation\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/loyalty/v3/stores/{{store_id}}/custom_actions?access_token={{access_token}}","description":"Records an action performed by a customer and applies it to all active custom action earning rules.
\n","urlObject":{"protocol":"https","path":["loyalty","v3","stores","{{store_id}}","custom_actions"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"29667087-ff4b-4892-b914-346d40c06540"}],"id":"64f40601-728c-4a33-a7dc-700d4d907ea3","_postman_id":"64f40601-728c-4a33-a7dc-700d4d907ea3","description":""},{"name":"Comments for Reviews","item":[{"name":"Create New Comment","id":"0181d590-5859-441d-ae7c-4f965a31b5fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"{{comment_content}}\",\n \"public\": {{is_public}}\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/v2/{{store_id}}/reviews/{{review_id}}/comment?access_token={{access_token}}","description":"Creates a new comment on a published review.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","reviews","{{review_id}}","comment"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"0181d590-5859-441d-ae7c-4f965a31b5fa"},{"name":"Retrieve Existing Comment","id":"37250ec9-d121-4b97-83dd-e6e525134c50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/reviews/{{review_id}}/comment?access_token={{access_token}}","description":"Retrieves an existing comment and its related metadata by review_id.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","reviews","{{review_id}}","comment"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"37250ec9-d121-4b97-83dd-e6e525134c50"},{"name":"Update Existing Comment","id":"235fb4ef-e77a-489a-b1c1-e946adce17c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"{{comment_content}}\",\n \"public\": {{is_public}}\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/v2/{{store_id}}/reviews/{{review_id}}/comment?access_token={{access_token}}","description":"Updates (edits) an existing comment on a published review.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","reviews","{{review_id}}","comment"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"235fb4ef-e77a-489a-b1c1-e946adce17c9"},{"name":"Delete Comment","id":"fbc21ac4-3678-4333-a127-f139b2b75dbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/reviews/{{review_id}}/comment?access_token={{access_token}}","description":"Deletes an existing comment on a published review.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","reviews","{{review_id}}","comment"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"fbc21ac4-3678-4333-a127-f139b2b75dbb"}],"id":"2af29094-7f0e-47d4-a0f4-c6b10baf30c0","_postman_id":"2af29094-7f0e-47d4-a0f4-c6b10baf30c0","description":""},{"name":"Q&A","item":[{"name":"Retrieve All Questions","id":"99db266e-3e02-402f-930c-5084c3e2dcee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/questions?access_token={{access_token}}&page={{page}}&count={{count}}","description":"Returns all Q&A questions and their answers for the specified account_id.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","questions"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"},{"key":"page","value":"{{page}}"},{"key":"count","value":"{{count}}"}],"variable":[]}},"response":[],"_postman_id":"99db266e-3e02-402f-930c-5084c3e2dcee"},{"name":"Retrieve Questions and Answers for a Product","id":"9fc82072-5f6d-497f-ae33-5598b15f6d71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.yotpo.com/products/{{store_id}}/{{sku}}/questions","description":"Retrieve Questions and Answers for a given product using the product SKU number.
\n","urlObject":{"protocol":"https","path":["products","{{store_id}}","{{sku}}","questions"],"host":["api","yotpo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9fc82072-5f6d-497f-ae33-5598b15f6d71"},{"name":"Retrieve the Bottom Line for Questions and Answers","id":"9b131213-e7c6-482d-a453-8e67982d3609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.yotpo.com/products/{{store_id}}/{{sku}}/qna_bottomline","description":"Retrieve the Bottom Line for a given product using the product SKU number. The Bottom Line will return the total questions and total answers for the desired product.
\n","urlObject":{"protocol":"https","path":["products","{{store_id}}","{{sku}}","qna_bottomline"],"host":["api","yotpo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b131213-e7c6-482d-a453-8e67982d3609"},{"name":"Vote on Answer","id":"c99f79ad-8773-449c-a376-0845f92c5821","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.yotpo.com/answers/{{answer_id}}/vote/{{vote_type}}","description":"Vote up or down on a particular answer to a question by answer_id.
\n","urlObject":{"protocol":"https","path":["answers","{{answer_id}}","vote","{{vote_type}}"],"host":["api","yotpo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c99f79ad-8773-449c-a376-0845f92c5821"}],"id":"44173fc2-9cd2-4aa6-9e66-7497c5fca0ba","_postman_id":"44173fc2-9cd2-4aa6-9e66-7497c5fca0ba","description":""},{"name":"Visual UGC","item":[{"name":"Get Photos by Album","id":"2b33a557-da52-44f9-bd13-2a4aaf915fdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.yotpo.com/v1/widget/{{store_id}}/albums/by_name","description":"Fetches the custom album payload including album images, tags, names, and IDs of all existing custom albums per account app_key.
\n","urlObject":{"protocol":"https","path":["v1","widget","{{store_id}}","albums","by_name"],"host":["api","yotpo","com"],"query":[{"disabled":true,"description":{"content":"The name of your custom album
\n","type":"text/plain"},"key":"album_name","value":"{{album_name}}"},{"disabled":true,"description":{"content":"The page number of a paginated response (default: 1)
\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"disabled":true,"description":{"content":"The number of results to return per page
\n","type":"text/plain"},"key":"per_page","value":"{{per_page}}"},{"disabled":true,"description":{"content":"Retrieve only starred (true) or unstarred (false) images
\n","type":"text/plain"},"key":"favorite","value":"{{favorite}}"}],"variable":[]}},"response":[],"_postman_id":"2b33a557-da52-44f9-bd13-2a4aaf915fdf"},{"name":"Get Product Images","id":"8323f29e-4e92-489c-bb15-1ea4d1bdc7a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.yotpo.com/v1/widget/{{store_id}}/albums/product/{{product_id}}","description":"Use this endpoint to retrieve images curated to product albums.
\n","urlObject":{"protocol":"https","path":["v1","widget","{{store_id}}","albums","product","{{product_id}}"],"host":["api","yotpo","com"],"query":[{"disabled":true,"description":{"content":"The page number of a paginated response (default: 1)
\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"disabled":true,"description":{"content":"The number of results to return per page
\n","type":"text/plain"},"key":"per_page","value":"{{per_page}}"},{"disabled":true,"description":{"content":"Retrieve only starred (true) or unstarred (false) images
\n","type":"text/plain"},"key":"favorite","value":"{{favorite}}"}],"variable":[]}},"response":[],"_postman_id":"8323f29e-4e92-489c-bb15-1ea4d1bdc7a7"}],"id":"f159ec23-c7e4-4db6-a3ce-953b7645789d","_postman_id":"f159ec23-c7e4-4db6-a3ce-953b7645789d","description":""},{"name":"Review Webhooks","item":[{"name":"Create Webhook","id":"434a9bb4-f4c8-4571-8387-672b1f7b146d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"http://www.yourwebsite.com\",\n \"event_name\": \"review_create\"\n}"},"url":"https://developers.yotpo.com/v2/{{store_id}}/webhooks?access_token={{access_token}}","description":"Create a webhook for Yotpo reviews
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","webhooks"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"434a9bb4-f4c8-4571-8387-672b1f7b146d"},{"name":"All Webhooks","id":"47c2e468-05dc-4a41-9ba9-df7f2273a959","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/webhooks?access_token={{access_token}}","description":"Retrieve a list of all webhooks created per account
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","webhooks"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"47c2e468-05dc-4a41-9ba9-df7f2273a959"},{"name":"All Webhook Events","id":"738e2272-6210-4cfe-b5a3-f410d71da6dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/webhook_events?access_token={{access_token}}","description":"Retrieve data on webhook events including event names and their descriptions
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","webhook_events"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"738e2272-6210-4cfe-b5a3-f410d71da6dc"},{"name":"Webhook By ID","id":"ce5016df-d496-4bbb-bb24-8dfae4764f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/webhooks/{{webhook_id}}?access_token={{access_token}}","description":"Retrieve webhook URLs, event names, and event IDs by webhook id
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","webhooks","{{webhook_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"ce5016df-d496-4bbb-bb24-8dfae4764f89"},{"name":"Update Webhook By ID","id":"2233f680-3bc4-4bbc-9bee-b686984c57a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"http://www.hello.com\",\n \"event_name\": \"review_create\"\n}"},"url":"https://developers.yotpo.com/v2/{{store_id}}/webhooks/:id?access_token={{access_token}}","description":"Update your webhook URL or event_name by webhook id.
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","webhooks",":id"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[{"description":{"content":"The webhook ID. Can be found using Retrieve All Webhooks
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"2233f680-3bc4-4bbc-9bee-b686984c57a0"},{"name":"Delete Webhook","id":"3e0a9b76-d0f3-463f-8791-a5a93b37babe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"accept","value":"application/json"}],"url":"https://developers.yotpo.com/v2/{{store_id}}/webhooks/:id?access_token={{access_token}}","description":"Delete webhooks by webhook id. The id can be found using All Webhooks
\n","urlObject":{"protocol":"https","path":["v2","{{store_id}}","webhooks",":id"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[{"description":{"content":"The webhook ID. Can be found using All Webhooks
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"3e0a9b76-d0f3-463f-8791-a5a93b37babe"}],"id":"49353f8a-8e07-4ac0-b57a-66d84e2ffd75","_postman_id":"49353f8a-8e07-4ac0-b57a-66d84e2ffd75","description":""},{"name":"Yotpo Webhooks","item":[{"name":"Store-level webhook subscriptions","item":[{"name":"Create store subscription","id":"294fc1a7-8dbf-4f8f-80bd-ea1ad567e7b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook_subscription\": {\n \"target_id\": {{target_id}},\n \"filter_id\": {{filter_id}},\n \"active\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/stores/{{store_id}}/webhooks/subscriptions?access_token={{access_token}}","description":"Create a unique store subscription per account, using each merchant's specific access token and store id. Combine the target and filter to create a subscription.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","stores","{{store_id}}","webhooks","subscriptions"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"294fc1a7-8dbf-4f8f-80bd-ea1ad567e7b4"},{"name":"Retrieve store subscriptions","id":"60501bb0-340f-4bc7-af81-6c4bc576be11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/stores/{{store_id}}/webhooks/subscriptions?access_token={{access_token}}","description":"Retrieves a list of all of the webhook subscriptions per account.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","stores","{{store_id}}","webhooks","subscriptions"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"60501bb0-340f-4bc7-af81-6c4bc576be11"},{"name":"Retrieve store subscription by ID","id":"b25d826a-eb09-46ff-aaa7-ea48d7c0efc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/stores/{{store_id}}/webhooks/subscriptions/:yotpo_subscription_id?access_token={{access_token}}","description":"Retrieves a webhook subscription using its Yotpo ID.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","stores","{{store_id}}","webhooks","subscriptions",":yotpo_subscription_id"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[{"description":{"content":"The ID of the subscription to get
\n","type":"text/plain"},"type":"any","value":"{{yotpo_subscription_id}}","key":"yotpo_subscription_id"}]}},"response":[],"_postman_id":"b25d826a-eb09-46ff-aaa7-ea48d7c0efc3"},{"name":"Update store subscription","id":"46c654bf-8600-4943-a4b2-23920c0ef382","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook_subscription\": {\n \"target_id\": {{target_id}},\n \"filter_id\": {{filter_id}},\n \"active\": {{active}}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/stores/{{store_id}}/webhooks/subscriptions/{{yotpo_subscription_id}}?access_token={{access_token}}","description":"Updates a webhook subscription per account.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","stores","{{store_id}}","webhooks","subscriptions","{{yotpo_subscription_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"46c654bf-8600-4943-a4b2-23920c0ef382"},{"name":"Delete store subscription","id":"a57ffdd6-955b-42ed-86b1-5ed853c61496","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/stores/{{store_id}}/webhooks/subscriptions/{{yotpo_subscription_id}}?access_token={{access_token}}","description":"Deletes a webhook subscription per account. IMPORTANT: A subscription must be deleted once a merchant uninstalls the app. This should apply if the merchant is uninstalling the app or is no longer a customer of your service.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","stores","{{store_id}}","webhooks","subscriptions","{{yotpo_subscription_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"a57ffdd6-955b-42ed-86b1-5ed853c61496"}],"id":"c8919955-45bc-44cb-89c8-43b7153d8354","_postman_id":"c8919955-45bc-44cb-89c8-43b7153d8354","description":""},{"name":"App-level webhook subscriptions","item":[{"name":"Create app subscription","id":"3490bab0-6e94-46f9-8b1a-82274e054bfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook_subscription\": {\n \"target_id\": {{target_id}},\n \"filter_id\": {{filter_id}},\n \"active\": {{active}}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/applications/:application_id/webhooks/subscriptions?access_token={{access_token}}","description":"Create an app webhook subscription
\n","urlObject":{"protocol":"https","path":["core","v3","applications",":application_id","webhooks","subscriptions"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[{"id":"a50aba09-25b6-4bef-8431-207eee92eb5a","description":{"content":"The application ID you received from Yotpo. Replace with your unique 'kong_client' ID (aka 'application_id')
\n","type":"text/plain"},"type":"any","value":"{{application_id}}","key":"application_id"}]}},"response":[],"_postman_id":"3490bab0-6e94-46f9-8b1a-82274e054bfe"},{"name":"Retrieve app subscriptions","id":"73ca69bb-cc3b-4813-87a4-091b65e7f53a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/:application_id/webhooks/subscriptions?access_token={{access_token}}","description":"Retrieve a list of all of your app webhook subscriptions
\n","urlObject":{"protocol":"https","path":["core","v3","applications",":application_id","webhooks","subscriptions"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[{"id":"c7ec7414-6bf9-47a6-9675-234d28cc05c4","description":{"content":"The application ID you received from Yotpo. Replace with your unique 'kong_client' ID (aka 'application_id')
\n","type":"text/plain"},"type":"any","value":"{{application_id}}","key":"application_id"}]}},"response":[],"_postman_id":"73ca69bb-cc3b-4813-87a4-091b65e7f53a"},{"name":"Retrieve app subscription by ID","id":"a7f24fdb-c2e7-4e19-a270-258279e18de0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/subscriptions/{{yotpo_subscription_id}}?access_token={{access_token}}","description":"Retrieve an app webhook subscription using its Yotpo ID
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","subscriptions","{{yotpo_subscription_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"a7f24fdb-c2e7-4e19-a270-258279e18de0"},{"name":"Update app subscription","id":"1c46052d-982a-496b-9ddc-f5cf7ee01651","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook_subscription\": {\n \"target_id\": {{target_id}},\n \"filter_id\": {{filter_id}},\n \"active\": {{active}}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/subscriptions/{{yotpo_subscription_id}}?access_token={{access_token}}","description":"Update an app webhook subscription. To skip a parameter, enter 'null' or exclude it from the payload.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","subscriptions","{{yotpo_subscription_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"1c46052d-982a-496b-9ddc-f5cf7ee01651"},{"name":"Delete app subscription","id":"38006aee-4c9b-4110-9f9f-f57ca37974a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/subscriptions/{{yotpo_subscription_id}}?access_token={{access_token}}","description":"Deletes a webhook subscription per account. IMPORTANT: A subscription must be deleted once a merchant uninstalls the app. The subscription deletion must be part of uninstalling your app. This should apply if the merchant is uninstalling the app or is no longer a customer of your service.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","subscriptions","{{yotpo_subscription_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"38006aee-4c9b-4110-9f9f-f57ca37974a3"}],"id":"62bba98a-925a-4c9a-9989-97db669961bf","_postman_id":"62bba98a-925a-4c9a-9989-97db669961bf","description":""},{"name":"Create Target","id":"a751a5b6-af86-45b0-b9ae-4709272250bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook_target\": {\n \"url\": \"https://www.example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/targets?access_token={{access_token}}","description":"Creates a webhook target or callback URL for listening to events. The webhook target can be used to listen to multiple events from multiple accounts.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","targets"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"a751a5b6-af86-45b0-b9ae-4709272250bf"},{"name":"Retrieve Targets","id":"eacf21eb-9ae6-459e-8e5f-4a675d79f0ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/targets?access_token={{access_token}}","description":"Retrieves a list of all of your webhook targets.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","targets"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"eacf21eb-9ae6-459e-8e5f-4a675d79f0ca"},{"name":"Retrieve Target by ID","id":"ae06bf6a-e5bf-4855-8263-24d59f292de9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/targets/{{yotpo_target_id}}?access_token={{access_token}}","description":"Retrieves a webhook target using its Yotpo ID.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","targets","{{yotpo_target_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"ae06bf6a-e5bf-4855-8263-24d59f292de9"},{"name":"Update Target","id":"e67e349d-907f-4d52-8979-0e0603c4fe29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook_target\": {\n \"url\": \"https://www.example.com/\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/targets/{{yotpo_target_id}}?access_token={{access_token}}","description":"Updates a webhook target. This webhook target can be used for listening to multiple events from multiple accounts.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","targets","{{yotpo_target_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"e67e349d-907f-4d52-8979-0e0603c4fe29"},{"name":"Delete Target","id":"4ccd524f-9443-44ca-b6ca-9e4cde2cf96b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/targets/{{yotpo_target_id}}?acccess_token={{access_token}}","description":"Deletes a webhook target. This webhook target can be used for listening to multiple events from multiple accounts, and so only unused webhook targets can be deleted.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","targets","{{yotpo_target_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"acccess_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"4ccd524f-9443-44ca-b6ca-9e4cde2cf96b"},{"name":"Create Filter","id":"9ad7851a-66ae-4915-ab11-2a93046805a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook_filter\": {\n \"events\": [\n \"swell/redemption/created\",\n \"loyalty/custom/reward/created\",\n \"loyalty/customer/anniversary\",\n \"loyalty/anniversary/captured\",\n \"swell/customer/birthday\",\n \"swell/birthday/captured\",\n \"loyalty/donation/created\",\n \"loyalty/opt_in\",\n \"loyalty/opt_out\",\n \"swell/points/changed\",\n \"swell/points/earned\",\n \"swell/redemption_code/below_threshold\",\n \"swell/points/reminder\",\n \"swell/redemption/reminder\",\n \"swell/referral/completed\",\n \"swell/referral/share\",\n \"swell/referral/share/reminder\",\n \"swell/tier/earned\",\n \"swell/tier/lost\",\n \"swell/tier/status/changed\",\n \"loyalty/referral/product_share/reminder\",\n \"loyalty/referral/product_share\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/filters?access_token={{access_token}}","description":"Create a webhook filter. This webhook filter can be used with multiple webhook targets. An event type cannot be used twice in the same webhook filter.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","filters"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"9ad7851a-66ae-4915-ab11-2a93046805a9"},{"name":"Retrieve filters","id":"9bf6ad6a-037b-45df-97a2-a472e36a8685","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/filters?access_token={{access_token}}","description":"Retrieves a list of all of your webhook filters.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","filters"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"9bf6ad6a-037b-45df-97a2-a472e36a8685"},{"name":"Retrieve filter by ID","id":"7b61e2c0-34af-427d-9c3a-0d50ef8d87c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/filters/{{yotpo_filter_id}}?access_token={{access_token}}","description":"Retrieves a webhook filter using its Yotpo ID.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","filters","{{yotpo_filter_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"7b61e2c0-34af-427d-9c3a-0d50ef8d87c9"},{"name":"Update filter","id":"e4247d37-c5ae-4693-b4d7-3b3802054ac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"webhook_filter\": {\n \"events\": [\n \"sms.customer.subscribed\",\n \"sms.customer.unsubscribed\",\n \"loyalty.points.earned.v1\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/filters/{{yotpo_filter_id}}?access_token={{access_token}}","description":"Updates a webhook filter. This webhook filter can be used with multiple webhook targets.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","filters","{{yotpo_filter_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"e4247d37-c5ae-4693-b4d7-3b3802054ac6"},{"name":"Delete filter","id":"4234ab66-7c9b-4aac-a280-7f1d25583428","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://developers.yotpo.com/core/v3/applications/{{application_id}}/webhooks/filters/{{yotpo_filter_id}}?access_token={{access_token}}","description":"Deletes a webhook filter. This webhook filter can be used with multiple webhook targets, so only unused webhook filters can be deleted.
\n","urlObject":{"protocol":"https","path":["core","v3","applications","{{application_id}}","webhooks","filters","{{yotpo_filter_id}}"],"host":["developers","yotpo","com"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[],"_postman_id":"4234ab66-7c9b-4aac-a280-7f1d25583428"}],"id":"8f29c9a0-10f9-4832-adf3-2ecbeb5ff3a6","_postman_id":"8f29c9a0-10f9-4832-adf3-2ecbeb5ff3a6","description":""}]}