Feefo

<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1733251405407"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.239.0"><meta name="readme-subdomain" content="feefo"><meta name="readme-version" content="2.0"><title>Feefo</title><meta name="description"><meta property="og:title" content="Feefo"><meta property="og:description"><meta property="og:site_name" content="Feefo"><meta name="twitter:title" content="Feefo"><meta name="twitter:description"><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/e01f0ec-small-Feefo_logo_white.png"><meta name="twitter:image" content="https://files.readme.io/e01f0ec-small-Feefo_logo_white.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/ldWWBKRDRmuxX4MgeGKd_favicon.ico" type="image/x-icon"><link rel="canonical" href="https://feefo.readme.io/"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1733251405407"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.d9c673efc10d86fdf1b5.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a810b19040de05f1c1ce.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.de26ae77a22f63cc7421.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.b8520cde412c1642dc0b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2406.951963c0cf542b4b86a4.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/73.535ee2b3bfca871baf6d.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8263.3d098f45b4b562ec80b5.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.49bb02ec5acf87fd228c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.9119a4e00e8cb781f8b7.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6722.386671bc80030984d9c0.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.4f1c8dfacfeed0a6ea87.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.a0c700eb9ae5192d6433.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.18ddfae65f140c2e4c1e.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.3337538299592ef842e6.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.3a8d675d9cf79a25b071.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="core-icons-inbox-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.de26ae77a22f63cc7421.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a810b19040de05f1c1ce.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.d9c673efc10d86fdf1b5.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"><style title="rm-custom-css">:root{--project-color-primary:#fdd100;--project-color-inverse:#222;--recipe-button-color:#1b2cf8;--recipe-button-color-hover:#0512a8;--recipe-button-color-active:#040c76;--recipe-button-color-focus:rgba(27, 44, 248, 0.25);--recipe-button-color-disabled:#e1e3fe}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#fdd100;--project-color-inverse:#222}a{color:var(--color-link-primary,#1b2cf8)}a:hover{color:var(--color-link-primary-darken-5,#0512a8)}a.text-muted:hover{color:var(--color-link-primary,#1b2cf8)}.btn.btn-primary{background-color:#1b2cf8}.btn.btn-primary:hover{background-color:#0512a8}.theme-line #hub-landing-top h2{color:#1b2cf8}#hub-landing-top .btn:hover{color:#1b2cf8}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#fdd100}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#fdd100,#b09200)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(https://files.readme.io/8bd1e15-Feefo_banner_new.png)}.theme-line header#hub-header #header-top{border-bottom-color:#fdd100}.theme-line header#hub-header #header-top .btn{background-color:#fdd100}header#hub-header #header-top #header-logo{width:172px;height:40px;margin-top:0;background-image:url(https://files.readme.io/4cac3a4-small-Feefo_logo_colour.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#fdd100}#subheader-links a.active{color:#fdd100!important;box-shadow:inset 0 -2px 0 #fdd100}#subheader-links a:hover{color:#fdd100!important;box-shadow:inset 0 -2px 0 #fdd100;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#1b2cf8}section#hub-discuss .discussion a .discuss-body h4{color:#1b2cf8}section#hub-discuss .discussion a:hover .discuss-body h4{color:#0512a8}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#1b2cf8}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#1b2cf8}#hub-search-results h3 em{color:#1b2cf8}.main_background,.tag-item{background:#1b2cf8!important}.main_background:hover{background:#0512a8!important}.main_color{color:#fdd100!important}.border_bottom_main_color{border-bottom:2px solid #fdd100}.main_color_hover:hover{color:#fdd100!important}section#hub-discuss h1{color:#1b2cf8}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#1b2cf8;background-color:#1b2cf8}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#0512a8;border-color:#0512a8}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#1b2cf8;color:#1b2cf8}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#1b2cf8);border-color:var(--project-color-primary,#1b2cf8)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#0512a8;border-color:#0512a8}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#1b2cf8;fill:var(--project-color-primary,#1b2cf8)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#1b2cf8}.main-color-accent{border-bottom:3px solid #fdd100;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES *//*! END HUB_CUSTOM_STYLES */</style><meta name="loadedProject" content="feefo"><script>var storedColorMode = `light` === 'system' ? window.localStorage.getItem('color-scheme') : `light` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.239.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-overlay header-bg-size-cover header-bg-pos-cr header-overlay-circuits reference-layout-row lumosity-light no-sidebar hub-is-home"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_light " style="--color-primary:#fdd100;--color-primary-inverse:#384248;--color-primary-alt:#b09200;--color-primary-darken-10:#caa700;--color-primary-darken-20:#977d00;--color-primary-alpha-25:rgba(253, 209, 0, 0.25);--color-link-primary:#1b2cf8;--color-link-primary-darken-5:#0719f2;--color-link-primary-darken-10:#0717d9;--color-link-primary-darken-20:#0512a8;--color-link-primary-alpha-50:rgba(27, 44, 248, 0.5);--color-link-primary-alpha-25:rgba(27, 44, 248, 0.25);--color-link-background:rgba(27, 44, 248, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header rm-Header_overlay rm-Header_overlay-circuits"><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/" target="_self"><img alt="Feefo" class="rm-Logo-img rm-Logo-img_lg Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/4cac3a4-small-Feefo_logo_colour.png"/></a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/reference" target="_self">API Reference</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://support.feefo.com" target="_self" to="https://support.feefo.com">Support</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/recipes" target="_self"><i class="icon-recipes NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Recipes</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><div class="NavItem-item1gDDTqaXGhm1 NavItem-item_inactiveMQoyhN045qAn">v2.0</div><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/search" target="_self"></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/reference" target="_self">API Reference</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://support.feefo.com" rel="noopener" target="_blank" to="https://support.feefo.com">Support</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/login?redirect_uri=/" target="_self" to="/login?redirect_uri=/">Log In</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/" target="_self"><img alt="Feefo" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/4cac3a4-small-Feefo_logo_colour.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-landing-page-2 Header-left-nav-icon10glJKFwewOv"></i>Home</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a href="/login?redirect_uri=/" target="_self" class="Button Button_slate_text Button_md Header-link2tXYTgXq85zW undefined NavItem_mdrYO3ChA2kYvP rm-Header-top-link rm-Header-top-link_login Button_primary">Log In</a></span></div></div><div class="undefined container"><section class="LandingPageHeader20SNhBZ58Jy5 rm-LandingPageHeader"><h1 class="LandingPageHeader-title16RMwPkp2O2W">Feefo Developer Hub</h1><div class="rm-Markdown markdown-body LandingPageHeader-text3zJOEVqnHdlf" data-testid="RDMD"><p>Welcome to the Feefo developer hub. You'll find comprehensive guides and documentation to help you start working with Feefo as quickly as possible, as well as support if you get stuck. Let's jump right in!</p></div><div><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="icon-search1 rm-SearchToggle-icon"></div><div class="undefined rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut">⌘K</div></button></div></section></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><span class="undefined NavItem_inactive1YE6SGanIJp5 rm-Header-bottom-link">v2.0</span><div class="Dropdown Dropdown_closed"><div class="Dropdown-toggle" aria-haspopup="dialog"><button class="rm-Header-link rm-Header-bottom-link undefined Button Button_slate_text Button_md" type="button"><span>Home</span><i class="undefined icon-chevron-down"></i></button></div></div></nav></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="LandingWrap16kRMSdr5J8g rm-LandingPage" id="content"><div class="LandingBlock3PM-HyBxby3X LandingBlock-Docs1N0x68Z0Yw2J LandingBlock_align=leftG1r7ROyW_AGB"><div class="markdown-body"><h3>Introduction</h3><ul><li><a href="/docs/getting-started">Feefo APIs Overview</a></li><li><a href="/docs/introduction">What are Sales?</a></li><li><a href="/docs/uploading-via-the-admin-portal">Uploading via the Admin Portal</a></li><li><a class="LandingBlock-link_viewAllX8PdNqsaoOrY" href="/docs/getting-started">View More… </a></li></ul></div><div class="markdown-body"><h3>Shopify Integration</h3><ul><li><a href="/docs/shopify">Shopify</a></li></ul></div><div class="markdown-body"><h3>Webhooks</h3><ul><li><a href="/docs/webhooks">Webhooks</a></li></ul></div><div class="markdown-body"><h3>ZAPIER</h3><ul><li><a href="/docs/using-zapier-to-integrate-feefo-with-other-apps">Using Zapier to integrate Feefo with other apps</a></li></ul></div></div><div class="LandingBlock3PM-HyBxby3X LandingBlock-Docs1N0x68Z0Yw2J LandingBlock_align=leftG1r7ROyW_AGB"><div class="markdown-body"><h3>Authentication</h3><ul><li><a href="/reference/api-authentication">API Authentication</a><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post" data-testid="http-method">post</span></li><li><a href="/reference/oauth-token">OAuth 2.0 Token</a><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post" data-testid="http-method">post</span></li></ul></div><div class="markdown-body"><h3>ENTER SALES API</h3><ul><li><a href="/reference/enter-sales-api">Enter Sales API</a><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_post" data-testid="http-method">post</span></li></ul></div><div class="markdown-body"><h3>Reviews API</h3><ul><li><a href="/reference/reviews-api-request">Reviews API Request</a><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get" data-testid="http-method">get</span></li></ul></div><div class="markdown-body"><h3>Reviews Summary</h3><ul><li><a href="/reference/review-summary-api-request">Reviews Summary API Request</a><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get" data-testid="http-method">get</span></li></ul></div><div class="markdown-body"><h3>PRODUCT RATING API</h3><ul><li><a href="/reference/product-ratings-api">Product Ratings API</a><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get" data-testid="http-method">get</span></li></ul></div><div class="markdown-body"><h3>Download Feedback API</h3><ul><li><a href="/reference/download-feedback-api">Download Feedback API</a><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get" data-testid="http-method">get</span></li></ul></div><div class="markdown-body"><h3>Reevoo Reviews API Migration</h3><ul><li><a href="/reference/reevoo-reviews-api-migration">Reevoo Reviews API Migration</a></li></ul></div></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"56d59dbff612b80b00fb69ab","slug":"documentation","title":"Introduction","version":"56d59dbff612b80b00fb69aa","createdAt":"2016-03-01T13:48:47.948Z","from_sync":false,"order":1,"pages":[{"_id":"56d59dc0f612b80b00fb69ad","type":"basic","category":"56d59dbff612b80b00fb69ab","link_external":false,"api":{"auth":"required","params":[],"url":"","examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"order":0,"slug":"getting-started","hidden":false,"createdAt":"2016-03-01T13:48:48.796Z","link_url":"","sync_unique":"","title":"Feefo APIs Overview","isReference":false,"deprecated":false,"icon":"","previousSlug":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"56d812547a04df0b00ddf00f","sync_unique":"","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","examples":{"codes":[]},"method":"get"},"link_url":"","title":"What are Sales?","category":"56d59dbff612b80b00fb69ab","isReference":false,"slug":"introduction","link_external":false,"order":1,"type":"basic","createdAt":"2016-03-03T10:30:44.332Z","hidden":false,"deprecated":false,"icon":"","previousSlug":"introduction-to-sales","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"56d815ecc83c5f0b00d28706","sync_unique":"","type":"basic","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","examples":{"codes":[]},"method":"get"},"createdAt":"2016-03-03T10:46:04.411Z","hidden":false,"title":"Uploading via the Admin Portal","category":"56d59dbff612b80b00fb69ab","order":2,"slug":"uploading-via-the-admin-portal","link_external":false,"link_url":"","isReference":false,"deprecated":false,"icon":"","previousSlug":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"65e89b50f24c86005e7d7019","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Content Security Policies","icon":"","type":"basic","slug":"content-security-policies","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"56d59dbff612b80b00fb69ab","createdAt":"2024-03-06T16:35:28.044Z","parentDoc":null,"isBodyEmpty":false,"children":[]}],"reference":false,"__v":1,"project":"56d59dbef612b80b00fb69a7"},{"_id":"56d5a28ac8c687150071f0e8","__v":1,"order":2,"project":"56d59dbef612b80b00fb69a7","reference":false,"title":"Shopify Integration","createdAt":"2016-03-01T14:09:14.366Z","from_sync":false,"pages":[{"_id":"64cd0207d65b9c00738ad59d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shopify","icon":"","type":"basic","slug":"shopify","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"56d5a28ac8c687150071f0e8","createdAt":"2023-08-04T13:49:59.647Z","parentDoc":null,"isBodyEmpty":false,"children":[]}],"slug":"shopify-integration","version":"56d59dbff612b80b00fb69aa"},{"_id":"64ccfc0d6bcd390052462445","title":"Webhooks","slug":"webhooks","order":9999,"reference":false,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2023-08-04T13:24:29.640Z","__v":0,"pages":[{"_id":"64ccfe0ef2c657007514756f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Webhooks","icon":"","type":"basic","slug":"webhooks","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64ccfc0d6bcd390052462445","createdAt":"2023-08-04T13:33:02.702Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"64ccfeb975e28e0046189243","title":"ZAPIER","slug":"zapier","order":9999,"reference":false,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2023-08-04T13:35:53.274Z","__v":0,"pages":[{"_id":"64ccffaee132f800576e2bab","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Using Zapier to integrate Feefo with other apps","icon":"","type":"basic","slug":"using-zapier-to-integrate-feefo-with-other-apps","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64ccfeb975e28e0046189243","createdAt":"2023-08-04T13:39:58.190Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"65e89212495dd0002be76ad7","title":"Authentication","slug":"how-to-connect-using-an-oauth-20-token","order":2,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:56:02.915Z","__v":0,"pages":[{"_id":"64ccecb08ba6cf000eb4c737","api":{"method":"post","url":"/apiauthenticate","auth":"required","examples":{"codes":[{"code":" \"authenticationDTO\": {\n \"merchantIdentifier\": \"example-retail-merchant\",\n \"username\": \"your_feefo_login@merchant.com\",\n \"password\": \"your_feefo_password\",\n \"apiKey\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"","language":"json","name":null},{"code":"","language":"text"}]},"params":[{"name":"authenticationDTO.merchantIdentifier","type":"string","enumValues":"","default":"","desc":"Unique identifier for the merchant account.","required":true,"in":"body","ref":"","_id":"65e85a811c491800575492ac"},{"name":"authenticationDTO.username","type":"string","enumValues":"","default":"","desc":"Unique identifier for the merchant account.","required":true,"in":"body","ref":"","_id":"65e85a811c491800575492ab"},{"name":"authenticationDTO.password","type":"string","enumValues":"","default":"","desc":"Password for a merchant admin Feefo account (best served by a dedicated API account for this purpose).","required":true,"in":"body","ref":"","_id":"65e85a811c491800575492aa"},{"name":"authenticationDTO.apiKey","type":"string","enumValues":"","default":"","desc":"API key for the merchant account.","required":true,"in":"body","ref":"","_id":"65e85a811c491800575492a9"}],"results":{"codes":[{"code":"{\n \"apiToken\": \"your_api_token\",\n \"expiresTime\": \"epoch_date_time\"\n}","language":"text","status":200},{"code":"","language":"text","status":200},{"code":"","language":"text","status":400}]},"settings":"","apiSetting":"65e8695b5d430c004d9dfb4a"},"title":"API Authentication","icon":"","type":"endpoint","slug":"api-authentication","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-to-connect-using-an-oauth-20-token-copy-1","parentDoc":null,"category":"65e89212495dd0002be76ad7","createdAt":"2023-08-04T12:18:56.401Z","isBodyEmpty":false,"children":[]},{"_id":"64ccc1c3089056002c0604be","api":{"method":"post","url":"/oauth/v2/token","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"client_id\": \"your-client-id\",\n \"client_secret\": \"your-client-secret\",\n \"grant_type\": \"client_credentials\"\n}"}]},"params":[{"name":"client_id","type":"string","enumValues":"","default":"","desc":"Your client id","required":true,"in":"body","ref":"","_id":"64ccc40ee0503300640f6a7b"},{"name":"client_secret","type":"string","enumValues":"","default":"","desc":"Your client secret","required":true,"in":"body","ref":"","_id":"64ccc40ee0503300640f6a7a"},{"name":"grant_type","type":"string","enumValues":"","default":"client_credentials","desc":"client credentials","required":true,"in":"body","ref":"","_id":"64ccc40ee0503300640f6a79"}],"results":{"codes":[{"code":"","language":"text","status":200},{"code":"","language":"text","status":400}]},"settings":"","apiSetting":"65e872b54a57c2001f2c2499"},"title":"OAuth 2.0 Token","icon":"","type":"endpoint","slug":"oauth-token","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"enter-sales-api-copy","category":"65e89212495dd0002be76ad7","createdAt":"2023-08-04T09:15:47.483Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"65e891b45d430c004d9e7e90","title":"ENTER SALES API","slug":"enter-sales-api","order":4,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:54:28.039Z","__v":0,"pages":[{"_id":"56d82ff27a04df0b00ddf08e","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"merchantidentifier\": \"example-retail-merchant\",\n \"apikey\": \"2de0a1ad-331b-49b1-a3d2-39a908c05209\",\n \"name\": \"John Smith\",\n \"email\": \"john@smith.com\",\n \"date\": \"2016-03-06\",\n \"feedbackdate\": \"2016-03-07\",\n \"orderref\": \"434242345\",\n \"description\": \"Leather belt\",\n \"productsearchcode\": \"ABC123\"\n}"}]},"method":"post","params":[{"name":"merchantidentifier","type":"string","enumValues":"","default":"","desc":"This value is a unique identifier for your account on Feefo which can be found within the merchant settings section of the admin portal.","required":true,"in":"body","ref":"","_id":"56d82ff27a04df0b00ddf092"},{"name":"apikey","type":"string","enumValues":"","default":"","desc":"A randomly generated alpha numeric value used for authenticating your Feefo account, this can be found within the merchant settings section of the Feefo Admin Portal.","required":true,"in":"body","ref":"","_id":"56d82ff27a04df0b00ddf091"},{"name":"name","type":"string","enumValues":"","default":"","desc":"The name of the purchaser.","required":true,"in":"body","ref":"","_id":"56e6e0ea764d572d00c3601b"},{"name":"email","type":"string","enumValues":"","default":"","desc":"The email address for the purchaser to which a feedback request will be sent.","required":true,"in":"body","ref":"","_id":"56d82ff27a04df0b00ddf090"},{"name":"customerref","type":"string","enumValues":"","default":"","desc":"Your unique identifier for the customer.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df224a"},{"name":"date","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"The date the transaction took place. When supplied incorrectly or without a value this will return an appropriate error message with a list of supported date formats; When the parameter is not present, Feefo will use the current date as the sale date and the feedback request will be sent immediately (assuming that feedbackdate is not specified). We recommend this is present with a valid value.","required":false,"in":"body","ref":"","_id":"56d82ff27a04df0b00ddf08f"},{"name":"feedbackdate","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"The date when a feedback request email should be sent to the customer. When not supplied, this will default to 7 days from date of sale or the number of days specified in the admin portal settings.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2249"},{"name":"orderref","type":"string","enumValues":"","default":"","desc":"Your unique identifier for the order made by the customer.","required":true,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2248"},{"name":"description","type":"string","enumValues":"","default":"","desc":"The name of the service/product purchased by the customer.","required":true,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2247"},{"name":"productsearchcode","type":"string","enumValues":"","default":"","desc":"Also referred to as a SKU, used to uniquely identify a product. When the parameter is not present or present without a value, the description will be assigned.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2246"},{"name":"productlink","type":"string","enumValues":"","default":"","desc":"The link to the product on your website. If an invalid product link value is supplied in a sale request this will be rejected with an error message displayed.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2245"},{"name":"amount","type":"double","enumValues":"","default":"","desc":"The cost of the product purchased. If an invalid numeric value is supplied in a sale request this will be rejected with an error message displayed.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2244"},{"name":"currency","type":"string","enumValues":"","default":"","desc":"The 3 letter ISO code for the sale value amount e.g. GBP.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2243"},{"name":"tag","type":"string","enumValues":"","default":"","desc":"Tagging data to associate with the sale and subsequent feedback. Format: Comma separated multiple key value pairs in the format key=value with “=” sign enclosed in square brackets. For GET requests the parameter should be URL encoded. POST Example: tag=[saleschannel=web,productline=Car Insurance]","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2242"}],"results":{"codes":[{"status":200,"name":"","code":"Sale processed successfully.","language":"text"},{"name":"","code":"An invalid sale request was made.","language":"text","status":400}]},"settings":"","url":"/entersaleremotely","apiSetting":"6335c8bda8c81e3e89801be9"},"link_url":"","slug":"enter-sales-api","title":"Enter Sales API","type":"endpoint","isReference":true,"category":"65e891b45d430c004d9e7e90","link_external":false,"order":0,"createdAt":"2016-03-03T12:37:06.762Z","hidden":false,"sync_unique":"","parentDoc":null,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"65e892634d97af005abc968d","title":"Reviews API","slug":"reviews-api","order":5,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:57:23.110Z","__v":0,"pages":[{"_id":"64ccd3d462eb2b006c5314d5","api":{"method":"get","url":"/20/reviews/{mode_choice}","auth":"required","examples":{"codes":[]},"params":[{"name":"mode_choice","type":"enum","enumValues":"service, product, nps, all","default":"all","desc":"","required":false,"in":"path","ref":"","_id":"65e883458fb43800120fea2e"},{"name":"tags","type":"string","enumValues":"","default":"","desc":"Filter for reviews with corresponding tags.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2625"},{"name":"date_time","type":"string","enumValues":"","default":"","desc":"Filter reviews to those created on a specified UTC date / time.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2624"},{"name":"updated_date_time","type":"string","enumValues":"","default":"","desc":"Filter reviews to those updated on a specified UTC date / time.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2623"},{"name":"since_period","type":"enum","enumValues":"month, year, all","default":"year","desc":"Filter reviews to those created during the specified period.","required":false,"in":"body","ref":"","_id":"65e883458fb43800120fea29"},{"name":"since_updated_period","type":"enum","enumValues":"month, year, all","default":"year","desc":"Filter reviews to those updated during the specified period.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2621"},{"name":"origin","type":"string","enumValues":"","default":"","desc":"Defines the domain name of the web page calling the Reviews API feed.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2620"},{"name":"id","type":"string","enumValues":"","default":"","desc":"Filter reviews based on the feedback id.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261f"},{"name":"parent_product_sku","type":"string","enumValues":"","default":"","desc":"Filter for product reviews assigned to the specified parent product search code.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261e"},{"name":"moderation_status","type":"enum","enumValues":"rejected, pending, published, all","default":"all","desc":"Filter reviews to include reviews in a status of moderation","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261d"},{"name":"product_sku","type":"string","enumValues":"","default":"","desc":"Filter for product reviews assigned to the specified product search code.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261c"},{"name":"customer_reference","type":"string","enumValues":"","default":"","desc":"Filter for reviews from a specific customer based on a unique customer reference.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261b"},{"name":"customer_email","type":"string","enumValues":"","default":"","desc":"Filter for reviews from a specific customer email.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261a"},{"name":"order_reference","type":"string","enumValues":"","default":"","desc":"Retrieve the feedback relating to a specific order.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2619"},{"name":"rating","type":"string","enumValues":"","default":"","desc":"Defines the number of stars or the NPS score that the reviews should have to be included in the feed.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2618"},{"name":"children","type":"enum","enumValues":"include, exclude","default":"Include","desc":"Specified if feedback from child account should be included in the result set.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2617"},{"name":"media","type":"enum","enumValues":"include, exclude","default":"include","desc":"Specifies filters applied to feedback with associated media.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2616"},{"name":"empty_product_comments","type":"enum","enumValues":"include, exclude","default":"include","desc":"Specifies how product reviews with no comments should be handled.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2615"},{"name":"Unanswered_feedback","type":"enum","enumValues":"include, exclude, exclude_negative","default":"include","desc":"Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2614"},{"name":"full_thread","type":"enum","enumValues":"include, exclude","default":"exclude","desc":"Specifies whether subsequent exchanges between the customer and merchant should be included in the response.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c6c"},{"name":"sort","type":"enum","enumValues":"","default":"updated_date","desc":"Dictates the fields upon which sorting can be applied.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c6b"},{"name":"page_size","type":"string","enumValues":"","default":"20","desc":"The number of reviews to return per page, limited to 100.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c6a"},{"name":"page","type":"string","enumValues":"","default":"1","desc":"The page number to return reviews for.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c69"},{"name":"fields","type":"string","enumValues":"","default":"","desc":"Limit the response to include certain fields.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c68"},{"name":"enhanced_insight","type":"enum","enumValues":"include, exclude","default":"exclude","desc":"Only functional if the account has Smart Themes enabled. Specifies if enhanced insight data should be included in the API response.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c67"},{"name":"feature","type":"string","enumValues":"","default":"","desc":"Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter. Filter reviews to those that include the associated feature.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c66"},{"name":"merchant_identifier","type":"string","enumValues":"","default":"","desc":"Unique identifier for the merchant account.","required":false,"in":"query","ref":"","_id":"65e99d925495ac001275f9ba"}],"results":{"codes":[{"code":"","language":"text","status":200},{"code":"","language":"text","status":400}]},"settings":"","apiSetting":"65e8695b5d430c004d9dfb4a"},"title":"Reviews API Request","icon":"","type":"endpoint","slug":"reviews-api-request","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"reviews-api-request-reviews-copy","category":"65e892634d97af005abc968d","createdAt":"2023-08-04T10:32:52.898Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64cce1a656ae2d003268f4f5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Reviews API Response","icon":"","type":"basic","slug":"reviews-api-response","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"reviews-api-response-reviews","parentDoc":"64ccd3d462eb2b006c5314d5","category":"65e892634d97af005abc968d","createdAt":"2023-08-04T11:31:50.908Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"65e8925ddf8d5f005863411d","title":"Reviews Summary","slug":"reviews-summary","order":6,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:57:17.475Z","__v":0,"pages":[{"_id":"64cccd2666ce23000a8ff9b2","api":{"method":"get","url":"/{mode_choice}","auth":"required","examples":{"codes":[]},"params":[{"name":"tags","type":"string","enumValues":"","default":"","desc":"Filter for reviews with corresponding tags.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee8"},{"name":"date_time","type":"string","enumValues":"","default":"","desc":"Filter reviews to those created on a specified UTC date / time.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee7"},{"name":"updated_date_time","type":"string","enumValues":"","default":"","desc":"Filter reviews to those updated on a specified UTC date / time.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee6"},{"name":"since_period","type":"enum","enumValues":"month, year, all","default":"year","desc":"Filter reviews to those created during the specified period.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee5"},{"name":"since_updated_period","type":"enum","enumValues":"month, year, all","default":"year","desc":"Filter reviews to those updated during the specified period.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee4"},{"name":"origin","type":"string","enumValues":"","default":"","desc":"Defines the domain name of the web page calling the Reviews API feed.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee3"},{"name":"id","type":"string","enumValues":"","default":"","desc":"Filter reviews based on the feedback id.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee2"},{"name":"parent_product_sku","type":"string","enumValues":"","default":"","desc":"Filter for product reviews assigned to the specified parent product search code.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee1"},{"name":"moderation_status","type":"enum","enumValues":"rejected, pending, published, all","default":"all","desc":"Filter reviews to include reviews in a status of moderation","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee0"},{"name":"product_sku","type":"string","enumValues":"","default":"","desc":"Filter for product reviews assigned to the specified product search code.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bedf"},{"name":"customer_reference","type":"string","enumValues":"","default":"","desc":"Filter for reviews from a specific customer based on a unique customer reference.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bede"},{"name":"customer_email","type":"string","enumValues":"","default":"","desc":"Filter for reviews from a specific customer email.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bedd"},{"name":"order_reference","type":"string","enumValues":"","default":"","desc":"Retrieve the feedback relating to a specific order.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bedc"},{"name":"rating","type":"string","enumValues":"","default":"","desc":"Defines the number of stars or the NPS score that the reviews should have to be included in the feed.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bedb"},{"name":"children","type":"enum","enumValues":"include, exclude","default":"include","desc":"Specified if feedback from child account should be included in the result set.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6beda"},{"name":"media","type":"enum","enumValues":"include, exclude, only, video, photo","default":"include","desc":"Specifies filters applied to feedback with associated media.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed9"},{"name":"empty_product_comments","type":"enum","enumValues":"include, exclude","default":"include","desc":"Specifies how product reviews with no comments should be handled.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed8"},{"name":"Unanswered_feedback","type":"enum","enumValues":"include, exclude, exclude_negative","default":"include","desc":"Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed7"},{"name":"enhanced_insight","type":"enum","enumValues":"include, exclude","default":"exclude","desc":"Only functional if the account has Smart Themes enabled. Specifies if enhanced insight data should be included in the API response.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed6"},{"name":"feature","type":"string","enumValues":"","default":"","desc":"Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter. Filter reviews to those that include the associated feature.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed5"},{"name":"mode_choice","type":"enum","enumValues":"service, product, nps, all","default":"all","desc":"","required":false,"in":"path","ref":"","_id":"65e8623f28aa640020d69dd0"},{"name":"merchant_identifier","type":"string","enumValues":"","default":"","desc":"Unique identifier for the merchant account.","required":false,"in":"query","ref":"","_id":"65e99daf74dc1d0048a411b2"}],"results":{"codes":[{"code":"","language":"text","status":100},{"code":"","language":"text","status":400},{"code":"","language":"text","status":200}]},"settings":"","apiSetting":"65e97d7c36776a00307387f0"},"title":"Reviews Summary API Request","icon":"","type":"endpoint","slug":"review-summary-api-request","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-to-connect-using-an-oauth-20-token-copy","category":"65e8925ddf8d5f005863411d","createdAt":"2023-08-04T10:04:22.911Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64ccddd562ef410018d39cd0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Reviews Summary API Response","icon":"","type":"basic","slug":"reviews-summary-api-response","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"reviews-api-response","parentDoc":"64cccd2666ce23000a8ff9b2","category":"65e8925ddf8d5f005863411d","createdAt":"2023-08-04T11:15:33.828Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"65e8926d1c491800575585bf","title":"PRODUCT RATING API","slug":"product-rating-api","order":7,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:57:33.633Z","__v":0,"pages":[{"_id":"64ccf2486f74c000337bde06","api":{"method":"get","url":"/20/products/ratings?merchant_identifier={merchant_identifier}","auth":"required","examples":{"codes":[{"language":"json","code":"{\"products\": [ \n{\"rating\":3.0,\"sku\":\"SKU187098864792156\",\"review_count\":1},\n{\"rating\":4.1,\"sku\":\"SKU1870981878808479\",\"review_count\":5},\n{\"rating\":4.8,\"sku\":\"ERPKIPEAPTG6M9H9Y1WZ\",\"review_count\":7} ]"}]},"params":[{"name":"merchant_identifier","type":"string","enumValues":"","default":"","desc":"is the merchant’s unique Feefo identifier, which in this example is example-retail-merchant. Your merchantidentifier can be found in the Feefo Hub.","required":false,"in":"path","ref":"","_id":"65e8588083afea007ae70134"},{"name":"review_count","type":"enum","enumValues":"false, true","default":"false","desc":"Review_count determines if the data returned includes the number of reviews over which the average is calculated. Default = false. If set to true, review_count is included with the product rating data.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423034"},{"name":"since_period","type":"enum","enumValues":"24_hours, week, month, year, all","default":"year","desc":"Since_period defines the period over which the average rating is calculated. Default = year.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423033"},{"name":"parent_product_sku","type":"string","enumValues":"","default":"","desc":"parent_product_sku returns only products with the corresponding parent_product_sku.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423032"},{"name":"product_sku","type":"string","enumValues":"","default":"","desc":"product_sku is a filter for product reviews assigned to the specified product search code. More than one product_sku can be provided in one request with each product_sku separated by a comma. The value of the product_sku is case insensitive and supports the use of an asterisk (*) as a wildcard character at the beginning and/or end of the supplied parameter to support partial matching for related/variant products.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423031"},{"name":"page_size","type":"string","enumValues":"","default":"20","desc":"page_size defines the number of reviews to return per page, the default is 20 and the maximum value is 100.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423030"},{"name":"page","type":"string","enumValues":"","default":"","desc":"page defines the page number to return reviews for, the default is 1.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c127001842302f"}],"results":{"codes":[{"code":"","language":"text","status":200},{"code":"","language":"text","status":400}]},"settings":"","apiSetting":"65e8695b5d430c004d9dfb4a"},"title":"Product Ratings API","icon":"","type":"endpoint","slug":"product-ratings-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-to-connect-using-an-oauth-20-token-copy-2","parentDoc":null,"category":"65e8926d1c491800575585bf","createdAt":"2023-08-04T12:42:48.370Z","isBodyEmpty":false,"children":[]}]},{"_id":"65e89c015c54b500479e189b","title":"Download Feedback API","slug":"download-feedback-api","order":8,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T16:38:25.862Z","__v":0,"pages":[{"_id":"65e89be1c596710043918889","api":{"method":"get","url":"/download-feedback?merchantidentifier={merchantidentifier}&apikey={apikey}&from={from}&to={to}&custom-question-format=json","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"merchantidentifier","type":"string","enumValues":"","default":"","desc":"The account to query from","required":false,"in":"path","ref":"","_id":"65e9856e36776a0030738a8e"},{"name":"apikey","type":"string","enumValues":"","default":"","desc":"Used for authentication. Mandatory, or an Unauthorised response will be made.","required":false,"in":"path","ref":"","_id":"65e9856e36776a0030738a8d"},{"name":"from","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"Dates with yyyy-mm-dd format","required":false,"in":"path","ref":"","_id":"65e9856e36776a0030738a8c"},{"name":"to","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"","required":false,"in":"path","ref":"","_id":"65e9856e36776a0030738a8b"}],"examples":{"codes":[{"code":"<https://api.feefo.com/api/download-feedback?merchantidentifier=adam-tech-test&apikey=7716e6fd-7282-44fc-8c8a-1c6c2e106868&from=2021-01-01&to=2022-03-03&custom-question-format=json>","language":"text"}]},"apiSetting":"65e8695b5d430c004d9dfb4a"},"title":"Download Feedback API","icon":"","type":"endpoint","slug":"download-feedback-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65e89c015c54b500479e189b","createdAt":"2024-03-06T16:37:53.672Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"65e89307d046d10030fa2a1c","title":"Reevoo Reviews API Migration","slug":"reevoo-reviews-api-migration","order":9,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T16:00:07.471Z","__v":0,"pages":[{"_id":"64ccf883d1153b0040418c61","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","examples":{"codes":[]}},"title":"Reevoo Reviews API Migration","icon":"","type":"basic","slug":"reevoo-reviews-api-migration","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"content-security-policies-copy","parentDoc":null,"category":"65e89307d046d10030fa2a1c","createdAt":"2023-08-04T13:09:23.570Z","isBodyEmpty":false,"children":[]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"MjQyODlhYmUxMGQ3NWVjYTllMjhkYjY4ZDY2Nzc3ZDgzZTBjOWZlNzJiZDc2MzJjYzliYzhkN2E2ZGNlZDAwZXRhZ0ZpbHRlcnM9KHByb2plY3Q6NTZkNTlkYmVmNjEyYjgwYjAwZmI2OWE3KSwodmVyc2lvbjpub25lLHZlcnNpb246NTZkNTlkYmZmNjEyYjgwYjAwZmI2OWFhKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2csaW5kZXg6VHV0b3JpYWwp","indexName":"readme_search_v2","projectsMeta":[{"modules":{"discuss":false,"blog":true,"reference":true,"examples":true,"docs":true,"landing":true,"changelog":true,"custompages":false,"logs":false,"suggested_edits":true,"tutorials":true,"graphql":false},"id":"56d59dbef612b80b00fb69a7","name":"Feefo","subdomain":"feefo","subpath":"","nav_names":{"discuss":"","blog":"","docs":"","changelog":"","reference":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"feefo"},"version":"2.0"}},"changelogs":[],"discuss":[{"anonymous_user":{"name":""},"algolia":{"recordCount":0,"publishPending":false,"updatedAt":"2024-06-24T09:30:15.050Z"},"title":"Review Schema","votes":0,"voters":[],"hub2voters":[],"views":6,"type":"question","solved":false,"body":"Hello Team,\n\nWe are using feefo review on our site and want to apply schema for review as suggested by our SEO team. Please suggest. \n\nThanks, \nSarkis Salleh","isSpam":false,"isFAQ":false,"edited":false,"comments":["66792405eea993003c426a07"],"tags":[],"revision":9,"_id":"6679118164f01a005a7e9c6a","createdAt":"2024-06-24T06:26:09.032Z","updatedAt":"2024-06-24T06:26:09.032Z","project":"56d59dbef612b80b00fb69a7","initVersion":"56d59dbff612b80b00fb69aa","hub2user":{"user":{"name":null},"_id":"66791096ad9d99001225fede"},"__v":1,"effective_user":{"name":null,"isAdmin":false},"vote_count":0,"id":"6679118164f01a005a7e9c6a"}],"docsCategories":[{"_id":"56d59dbff612b80b00fb69ab","slug":"documentation","title":"Introduction","version":"56d59dbff612b80b00fb69aa","createdAt":"2016-03-01T13:48:47.948Z","from_sync":false,"order":1,"pages":[{"_id":"56d59dc0f612b80b00fb69ad","type":"basic","category":"56d59dbff612b80b00fb69ab","link_external":false,"api":{"auth":"required","params":[],"url":"","examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"order":0,"slug":"getting-started","hidden":false,"createdAt":"2016-03-01T13:48:48.796Z","link_url":"","sync_unique":"","title":"Feefo APIs Overview","isReference":false,"deprecated":false,"icon":"","previousSlug":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"56d812547a04df0b00ddf00f","sync_unique":"","api":{"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","examples":{"codes":[]},"method":"get"},"link_url":"","title":"What are Sales?","category":"56d59dbff612b80b00fb69ab","isReference":false,"slug":"introduction","link_external":false,"order":1,"type":"basic","createdAt":"2016-03-03T10:30:44.332Z","hidden":false,"deprecated":false,"icon":"","previousSlug":"introduction-to-sales","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"56d815ecc83c5f0b00d28706","sync_unique":"","type":"basic","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","examples":{"codes":[]},"method":"get"},"createdAt":"2016-03-03T10:46:04.411Z","hidden":false,"title":"Uploading via the Admin Portal","category":"56d59dbff612b80b00fb69ab","order":2,"slug":"uploading-via-the-admin-portal","link_external":false,"link_url":"","isReference":false,"deprecated":false,"icon":"","previousSlug":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"65e89b50f24c86005e7d7019","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Content Security Policies","icon":"","type":"basic","slug":"content-security-policies","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"56d59dbff612b80b00fb69ab","createdAt":"2024-03-06T16:35:28.044Z","parentDoc":null,"isBodyEmpty":false,"children":[]}],"reference":false,"__v":1,"project":"56d59dbef612b80b00fb69a7"},{"_id":"56d5a28ac8c687150071f0e8","__v":1,"order":2,"project":"56d59dbef612b80b00fb69a7","reference":false,"title":"Shopify Integration","createdAt":"2016-03-01T14:09:14.366Z","from_sync":false,"pages":[{"_id":"64cd0207d65b9c00738ad59d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shopify","icon":"","type":"basic","slug":"shopify","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"56d5a28ac8c687150071f0e8","createdAt":"2023-08-04T13:49:59.647Z","parentDoc":null,"isBodyEmpty":false,"children":[]}],"slug":"shopify-integration","version":"56d59dbff612b80b00fb69aa"},{"_id":"64ccfc0d6bcd390052462445","title":"Webhooks","slug":"webhooks","order":9999,"reference":false,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2023-08-04T13:24:29.640Z","__v":0,"pages":[{"_id":"64ccfe0ef2c657007514756f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Webhooks","icon":"","type":"basic","slug":"webhooks","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64ccfc0d6bcd390052462445","createdAt":"2023-08-04T13:33:02.702Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"64ccfeb975e28e0046189243","title":"ZAPIER","slug":"zapier","order":9999,"reference":false,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2023-08-04T13:35:53.274Z","__v":0,"pages":[{"_id":"64ccffaee132f800576e2bab","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Using Zapier to integrate Feefo with other apps","icon":"","type":"basic","slug":"using-zapier-to-integrate-feefo-with-other-apps","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"64ccfeb975e28e0046189243","createdAt":"2023-08-04T13:39:58.190Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]}],"refCategories":[{"_id":"65e89212495dd0002be76ad7","title":"Authentication","slug":"how-to-connect-using-an-oauth-20-token","order":2,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:56:02.915Z","__v":0,"pages":[{"_id":"64ccecb08ba6cf000eb4c737","api":{"method":"post","url":"/apiauthenticate","auth":"required","examples":{"codes":[{"code":" \"authenticationDTO\": {\n \"merchantIdentifier\": \"example-retail-merchant\",\n \"username\": \"your_feefo_login@merchant.com\",\n \"password\": \"your_feefo_password\",\n \"apiKey\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"","language":"json","name":null},{"code":"","language":"text"}]},"params":[{"name":"authenticationDTO.merchantIdentifier","type":"string","enumValues":"","default":"","desc":"Unique identifier for the merchant account.","required":true,"in":"body","ref":"","_id":"65e85a811c491800575492ac"},{"name":"authenticationDTO.username","type":"string","enumValues":"","default":"","desc":"Unique identifier for the merchant account.","required":true,"in":"body","ref":"","_id":"65e85a811c491800575492ab"},{"name":"authenticationDTO.password","type":"string","enumValues":"","default":"","desc":"Password for a merchant admin Feefo account (best served by a dedicated API account for this purpose).","required":true,"in":"body","ref":"","_id":"65e85a811c491800575492aa"},{"name":"authenticationDTO.apiKey","type":"string","enumValues":"","default":"","desc":"API key for the merchant account.","required":true,"in":"body","ref":"","_id":"65e85a811c491800575492a9"}],"results":{"codes":[{"code":"{\n \"apiToken\": \"your_api_token\",\n \"expiresTime\": \"epoch_date_time\"\n}","language":"text","status":200},{"code":"","language":"text","status":200},{"code":"","language":"text","status":400}]},"settings":"","apiSetting":"65e8695b5d430c004d9dfb4a"},"title":"API Authentication","icon":"","type":"endpoint","slug":"api-authentication","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-to-connect-using-an-oauth-20-token-copy-1","parentDoc":null,"category":"65e89212495dd0002be76ad7","createdAt":"2023-08-04T12:18:56.401Z","isBodyEmpty":false,"children":[]},{"_id":"64ccc1c3089056002c0604be","api":{"method":"post","url":"/oauth/v2/token","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"client_id\": \"your-client-id\",\n \"client_secret\": \"your-client-secret\",\n \"grant_type\": \"client_credentials\"\n}"}]},"params":[{"name":"client_id","type":"string","enumValues":"","default":"","desc":"Your client id","required":true,"in":"body","ref":"","_id":"64ccc40ee0503300640f6a7b"},{"name":"client_secret","type":"string","enumValues":"","default":"","desc":"Your client secret","required":true,"in":"body","ref":"","_id":"64ccc40ee0503300640f6a7a"},{"name":"grant_type","type":"string","enumValues":"","default":"client_credentials","desc":"client credentials","required":true,"in":"body","ref":"","_id":"64ccc40ee0503300640f6a79"}],"results":{"codes":[{"code":"","language":"text","status":200},{"code":"","language":"text","status":400}]},"settings":"","apiSetting":"65e872b54a57c2001f2c2499"},"title":"OAuth 2.0 Token","icon":"","type":"endpoint","slug":"oauth-token","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"enter-sales-api-copy","category":"65e89212495dd0002be76ad7","createdAt":"2023-08-04T09:15:47.483Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"65e891b45d430c004d9e7e90","title":"ENTER SALES API","slug":"enter-sales-api","order":4,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:54:28.039Z","__v":0,"pages":[{"_id":"56d82ff27a04df0b00ddf08e","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"merchantidentifier\": \"example-retail-merchant\",\n \"apikey\": \"2de0a1ad-331b-49b1-a3d2-39a908c05209\",\n \"name\": \"John Smith\",\n \"email\": \"john@smith.com\",\n \"date\": \"2016-03-06\",\n \"feedbackdate\": \"2016-03-07\",\n \"orderref\": \"434242345\",\n \"description\": \"Leather belt\",\n \"productsearchcode\": \"ABC123\"\n}"}]},"method":"post","params":[{"name":"merchantidentifier","type":"string","enumValues":"","default":"","desc":"This value is a unique identifier for your account on Feefo which can be found within the merchant settings section of the admin portal.","required":true,"in":"body","ref":"","_id":"56d82ff27a04df0b00ddf092"},{"name":"apikey","type":"string","enumValues":"","default":"","desc":"A randomly generated alpha numeric value used for authenticating your Feefo account, this can be found within the merchant settings section of the Feefo Admin Portal.","required":true,"in":"body","ref":"","_id":"56d82ff27a04df0b00ddf091"},{"name":"name","type":"string","enumValues":"","default":"","desc":"The name of the purchaser.","required":true,"in":"body","ref":"","_id":"56e6e0ea764d572d00c3601b"},{"name":"email","type":"string","enumValues":"","default":"","desc":"The email address for the purchaser to which a feedback request will be sent.","required":true,"in":"body","ref":"","_id":"56d82ff27a04df0b00ddf090"},{"name":"customerref","type":"string","enumValues":"","default":"","desc":"Your unique identifier for the customer.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df224a"},{"name":"date","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"The date the transaction took place. When supplied incorrectly or without a value this will return an appropriate error message with a list of supported date formats; When the parameter is not present, Feefo will use the current date as the sale date and the feedback request will be sent immediately (assuming that feedbackdate is not specified). We recommend this is present with a valid value.","required":false,"in":"body","ref":"","_id":"56d82ff27a04df0b00ddf08f"},{"name":"feedbackdate","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"The date when a feedback request email should be sent to the customer. When not supplied, this will default to 7 days from date of sale or the number of days specified in the admin portal settings.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2249"},{"name":"orderref","type":"string","enumValues":"","default":"","desc":"Your unique identifier for the order made by the customer.","required":true,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2248"},{"name":"description","type":"string","enumValues":"","default":"","desc":"The name of the service/product purchased by the customer.","required":true,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2247"},{"name":"productsearchcode","type":"string","enumValues":"","default":"","desc":"Also referred to as a SKU, used to uniquely identify a product. When the parameter is not present or present without a value, the description will be assigned.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2246"},{"name":"productlink","type":"string","enumValues":"","default":"","desc":"The link to the product on your website. If an invalid product link value is supplied in a sale request this will be rejected with an error message displayed.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2245"},{"name":"amount","type":"double","enumValues":"","default":"","desc":"The cost of the product purchased. If an invalid numeric value is supplied in a sale request this will be rejected with an error message displayed.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2244"},{"name":"currency","type":"string","enumValues":"","default":"","desc":"The 3 letter ISO code for the sale value amount e.g. GBP.","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2243"},{"name":"tag","type":"string","enumValues":"","default":"","desc":"Tagging data to associate with the sale and subsequent feedback. Format: Comma separated multiple key value pairs in the format key=value with “=” sign enclosed in square brackets. For GET requests the parameter should be URL encoded. POST Example: tag=[saleschannel=web,productline=Car Insurance]","required":false,"in":"body","ref":"","_id":"56e6eeabf3b12a3200df2242"}],"results":{"codes":[{"status":200,"name":"","code":"Sale processed successfully.","language":"text"},{"name":"","code":"An invalid sale request was made.","language":"text","status":400}]},"settings":"","url":"/entersaleremotely","apiSetting":"6335c8bda8c81e3e89801be9"},"link_url":"","slug":"enter-sales-api","title":"Enter Sales API","type":"endpoint","isReference":true,"category":"65e891b45d430c004d9e7e90","link_external":false,"order":0,"createdAt":"2016-03-03T12:37:06.762Z","hidden":false,"sync_unique":"","parentDoc":null,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"65e892634d97af005abc968d","title":"Reviews API","slug":"reviews-api","order":5,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:57:23.110Z","__v":0,"pages":[{"_id":"64ccd3d462eb2b006c5314d5","api":{"method":"get","url":"/20/reviews/{mode_choice}","auth":"required","examples":{"codes":[]},"params":[{"name":"mode_choice","type":"enum","enumValues":"service, product, nps, all","default":"all","desc":"","required":false,"in":"path","ref":"","_id":"65e883458fb43800120fea2e"},{"name":"tags","type":"string","enumValues":"","default":"","desc":"Filter for reviews with corresponding tags.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2625"},{"name":"date_time","type":"string","enumValues":"","default":"","desc":"Filter reviews to those created on a specified UTC date / time.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2624"},{"name":"updated_date_time","type":"string","enumValues":"","default":"","desc":"Filter reviews to those updated on a specified UTC date / time.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2623"},{"name":"since_period","type":"enum","enumValues":"month, year, all","default":"year","desc":"Filter reviews to those created during the specified period.","required":false,"in":"body","ref":"","_id":"65e883458fb43800120fea29"},{"name":"since_updated_period","type":"enum","enumValues":"month, year, all","default":"year","desc":"Filter reviews to those updated during the specified period.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2621"},{"name":"origin","type":"string","enumValues":"","default":"","desc":"Defines the domain name of the web page calling the Reviews API feed.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2620"},{"name":"id","type":"string","enumValues":"","default":"","desc":"Filter reviews based on the feedback id.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261f"},{"name":"parent_product_sku","type":"string","enumValues":"","default":"","desc":"Filter for product reviews assigned to the specified parent product search code.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261e"},{"name":"moderation_status","type":"enum","enumValues":"rejected, pending, published, all","default":"all","desc":"Filter reviews to include reviews in a status of moderation","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261d"},{"name":"product_sku","type":"string","enumValues":"","default":"","desc":"Filter for product reviews assigned to the specified product search code.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261c"},{"name":"customer_reference","type":"string","enumValues":"","default":"","desc":"Filter for reviews from a specific customer based on a unique customer reference.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261b"},{"name":"customer_email","type":"string","enumValues":"","default":"","desc":"Filter for reviews from a specific customer email.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a261a"},{"name":"order_reference","type":"string","enumValues":"","default":"","desc":"Retrieve the feedback relating to a specific order.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2619"},{"name":"rating","type":"string","enumValues":"","default":"","desc":"Defines the number of stars or the NPS score that the reviews should have to be included in the feed.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2618"},{"name":"children","type":"enum","enumValues":"include, exclude","default":"Include","desc":"Specified if feedback from child account should be included in the result set.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2617"},{"name":"media","type":"enum","enumValues":"include, exclude","default":"include","desc":"Specifies filters applied to feedback with associated media.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2616"},{"name":"empty_product_comments","type":"enum","enumValues":"include, exclude","default":"include","desc":"Specifies how product reviews with no comments should be handled.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2615"},{"name":"Unanswered_feedback","type":"enum","enumValues":"include, exclude, exclude_negative","default":"include","desc":"Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours.","required":false,"in":"body","ref":"","_id":"64ccd1347d8e6f00613a2614"},{"name":"full_thread","type":"enum","enumValues":"include, exclude","default":"exclude","desc":"Specifies whether subsequent exchanges between the customer and merchant should be included in the response.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c6c"},{"name":"sort","type":"enum","enumValues":"","default":"updated_date","desc":"Dictates the fields upon which sorting can be applied.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c6b"},{"name":"page_size","type":"string","enumValues":"","default":"20","desc":"The number of reviews to return per page, limited to 100.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c6a"},{"name":"page","type":"string","enumValues":"","default":"1","desc":"The page number to return reviews for.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c69"},{"name":"fields","type":"string","enumValues":"","default":"","desc":"Limit the response to include certain fields.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c68"},{"name":"enhanced_insight","type":"enum","enumValues":"include, exclude","default":"exclude","desc":"Only functional if the account has Smart Themes enabled. Specifies if enhanced insight data should be included in the API response.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c67"},{"name":"feature","type":"string","enumValues":"","default":"","desc":"Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter. Filter reviews to those that include the associated feature.","required":false,"in":"body","ref":"","_id":"64ccd3c0b9bd7a0024008c66"},{"name":"merchant_identifier","type":"string","enumValues":"","default":"","desc":"Unique identifier for the merchant account.","required":false,"in":"query","ref":"","_id":"65e99d925495ac001275f9ba"}],"results":{"codes":[{"code":"","language":"text","status":200},{"code":"","language":"text","status":400}]},"settings":"","apiSetting":"65e8695b5d430c004d9dfb4a"},"title":"Reviews API Request","icon":"","type":"endpoint","slug":"reviews-api-request","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"reviews-api-request-reviews-copy","category":"65e892634d97af005abc968d","createdAt":"2023-08-04T10:32:52.898Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64cce1a656ae2d003268f4f5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Reviews API Response","icon":"","type":"basic","slug":"reviews-api-response","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"reviews-api-response-reviews","parentDoc":"64ccd3d462eb2b006c5314d5","category":"65e892634d97af005abc968d","createdAt":"2023-08-04T11:31:50.908Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"65e8925ddf8d5f005863411d","title":"Reviews Summary","slug":"reviews-summary","order":6,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:57:17.475Z","__v":0,"pages":[{"_id":"64cccd2666ce23000a8ff9b2","api":{"method":"get","url":"/{mode_choice}","auth":"required","examples":{"codes":[]},"params":[{"name":"tags","type":"string","enumValues":"","default":"","desc":"Filter for reviews with corresponding tags.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee8"},{"name":"date_time","type":"string","enumValues":"","default":"","desc":"Filter reviews to those created on a specified UTC date / time.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee7"},{"name":"updated_date_time","type":"string","enumValues":"","default":"","desc":"Filter reviews to those updated on a specified UTC date / time.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee6"},{"name":"since_period","type":"enum","enumValues":"month, year, all","default":"year","desc":"Filter reviews to those created during the specified period.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee5"},{"name":"since_updated_period","type":"enum","enumValues":"month, year, all","default":"year","desc":"Filter reviews to those updated during the specified period.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee4"},{"name":"origin","type":"string","enumValues":"","default":"","desc":"Defines the domain name of the web page calling the Reviews API feed.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee3"},{"name":"id","type":"string","enumValues":"","default":"","desc":"Filter reviews based on the feedback id.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee2"},{"name":"parent_product_sku","type":"string","enumValues":"","default":"","desc":"Filter for product reviews assigned to the specified parent product search code.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee1"},{"name":"moderation_status","type":"enum","enumValues":"rejected, pending, published, all","default":"all","desc":"Filter reviews to include reviews in a status of moderation","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bee0"},{"name":"product_sku","type":"string","enumValues":"","default":"","desc":"Filter for product reviews assigned to the specified product search code.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bedf"},{"name":"customer_reference","type":"string","enumValues":"","default":"","desc":"Filter for reviews from a specific customer based on a unique customer reference.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bede"},{"name":"customer_email","type":"string","enumValues":"","default":"","desc":"Filter for reviews from a specific customer email.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bedd"},{"name":"order_reference","type":"string","enumValues":"","default":"","desc":"Retrieve the feedback relating to a specific order.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bedc"},{"name":"rating","type":"string","enumValues":"","default":"","desc":"Defines the number of stars or the NPS score that the reviews should have to be included in the feed.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bedb"},{"name":"children","type":"enum","enumValues":"include, exclude","default":"include","desc":"Specified if feedback from child account should be included in the result set.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6beda"},{"name":"media","type":"enum","enumValues":"include, exclude, only, video, photo","default":"include","desc":"Specifies filters applied to feedback with associated media.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed9"},{"name":"empty_product_comments","type":"enum","enumValues":"include, exclude","default":"include","desc":"Specifies how product reviews with no comments should be handled.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed8"},{"name":"Unanswered_feedback","type":"enum","enumValues":"include, exclude, exclude_negative","default":"include","desc":"Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed7"},{"name":"enhanced_insight","type":"enum","enumValues":"include, exclude","default":"exclude","desc":"Only functional if the account has Smart Themes enabled. Specifies if enhanced insight data should be included in the API response.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed6"},{"name":"feature","type":"string","enumValues":"","default":"","desc":"Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter. Filter reviews to those that include the associated feature.","required":false,"in":"body","ref":"","_id":"64ccd147ae1db7000ca6bed5"},{"name":"mode_choice","type":"enum","enumValues":"service, product, nps, all","default":"all","desc":"","required":false,"in":"path","ref":"","_id":"65e8623f28aa640020d69dd0"},{"name":"merchant_identifier","type":"string","enumValues":"","default":"","desc":"Unique identifier for the merchant account.","required":false,"in":"query","ref":"","_id":"65e99daf74dc1d0048a411b2"}],"results":{"codes":[{"code":"","language":"text","status":100},{"code":"","language":"text","status":400},{"code":"","language":"text","status":200}]},"settings":"","apiSetting":"65e97d7c36776a00307387f0"},"title":"Reviews Summary API Request","icon":"","type":"endpoint","slug":"review-summary-api-request","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-to-connect-using-an-oauth-20-token-copy","category":"65e8925ddf8d5f005863411d","createdAt":"2023-08-04T10:04:22.911Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64ccddd562ef410018d39cd0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Reviews Summary API Response","icon":"","type":"basic","slug":"reviews-summary-api-response","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"reviews-api-response","parentDoc":"64cccd2666ce23000a8ff9b2","category":"65e8925ddf8d5f005863411d","createdAt":"2023-08-04T11:15:33.828Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"65e8926d1c491800575585bf","title":"PRODUCT RATING API","slug":"product-rating-api","order":7,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T15:57:33.633Z","__v":0,"pages":[{"_id":"64ccf2486f74c000337bde06","api":{"method":"get","url":"/20/products/ratings?merchant_identifier={merchant_identifier}","auth":"required","examples":{"codes":[{"language":"json","code":"{\"products\": [ \n{\"rating\":3.0,\"sku\":\"SKU187098864792156\",\"review_count\":1},\n{\"rating\":4.1,\"sku\":\"SKU1870981878808479\",\"review_count\":5},\n{\"rating\":4.8,\"sku\":\"ERPKIPEAPTG6M9H9Y1WZ\",\"review_count\":7} ]"}]},"params":[{"name":"merchant_identifier","type":"string","enumValues":"","default":"","desc":"is the merchant’s unique Feefo identifier, which in this example is example-retail-merchant. Your merchantidentifier can be found in the Feefo Hub.","required":false,"in":"path","ref":"","_id":"65e8588083afea007ae70134"},{"name":"review_count","type":"enum","enumValues":"false, true","default":"false","desc":"Review_count determines if the data returned includes the number of reviews over which the average is calculated. Default = false. If set to true, review_count is included with the product rating data.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423034"},{"name":"since_period","type":"enum","enumValues":"24_hours, week, month, year, all","default":"year","desc":"Since_period defines the period over which the average rating is calculated. Default = year.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423033"},{"name":"parent_product_sku","type":"string","enumValues":"","default":"","desc":"parent_product_sku returns only products with the corresponding parent_product_sku.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423032"},{"name":"product_sku","type":"string","enumValues":"","default":"","desc":"product_sku is a filter for product reviews assigned to the specified product search code. More than one product_sku can be provided in one request with each product_sku separated by a comma. The value of the product_sku is case insensitive and supports the use of an asterisk (*) as a wildcard character at the beginning and/or end of the supplied parameter to support partial matching for related/variant products.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423031"},{"name":"page_size","type":"string","enumValues":"","default":"20","desc":"page_size defines the number of reviews to return per page, the default is 20 and the maximum value is 100.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c1270018423030"},{"name":"page","type":"string","enumValues":"","default":"","desc":"page defines the page number to return reviews for, the default is 1.","required":false,"in":"query","ref":"","_id":"65e99cb4d0c127001842302f"}],"results":{"codes":[{"code":"","language":"text","status":200},{"code":"","language":"text","status":400}]},"settings":"","apiSetting":"65e8695b5d430c004d9dfb4a"},"title":"Product Ratings API","icon":"","type":"endpoint","slug":"product-ratings-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-to-connect-using-an-oauth-20-token-copy-2","parentDoc":null,"category":"65e8926d1c491800575585bf","createdAt":"2023-08-04T12:42:48.370Z","isBodyEmpty":false,"children":[]}]},{"_id":"65e89c015c54b500479e189b","title":"Download Feedback API","slug":"download-feedback-api","order":8,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T16:38:25.862Z","__v":0,"pages":[{"_id":"65e89be1c596710043918889","api":{"method":"get","url":"/download-feedback?merchantidentifier={merchantidentifier}&apikey={apikey}&from={from}&to={to}&custom-question-format=json","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"merchantidentifier","type":"string","enumValues":"","default":"","desc":"The account to query from","required":false,"in":"path","ref":"","_id":"65e9856e36776a0030738a8e"},{"name":"apikey","type":"string","enumValues":"","default":"","desc":"Used for authentication. Mandatory, or an Unauthorised response will be made.","required":false,"in":"path","ref":"","_id":"65e9856e36776a0030738a8d"},{"name":"from","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"Dates with yyyy-mm-dd format","required":false,"in":"path","ref":"","_id":"65e9856e36776a0030738a8c"},{"name":"to","type":"yyyy-mm-dd","enumValues":"","default":"","desc":"","required":false,"in":"path","ref":"","_id":"65e9856e36776a0030738a8b"}],"examples":{"codes":[{"code":"<https://api.feefo.com/api/download-feedback?merchantidentifier=adam-tech-test&apikey=7716e6fd-7282-44fc-8c8a-1c6c2e106868&from=2021-01-01&to=2022-03-03&custom-question-format=json>","language":"text"}]},"apiSetting":"65e8695b5d430c004d9dfb4a"},"title":"Download Feedback API","icon":"","type":"endpoint","slug":"download-feedback-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"65e89c015c54b500479e189b","createdAt":"2024-03-06T16:37:53.672Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"65e89307d046d10030fa2a1c","title":"Reevoo Reviews API Migration","slug":"reevoo-reviews-api-migration","order":9,"reference":true,"project":"56d59dbef612b80b00fb69a7","version":"56d59dbff612b80b00fb69aa","createdAt":"2024-03-06T16:00:07.471Z","__v":0,"pages":[{"_id":"64ccf883d1153b0040418c61","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","examples":{"codes":[]}},"title":"Reevoo Reviews API Migration","icon":"","type":"basic","slug":"reevoo-reviews-api-migration","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"content-security-policies-copy","parentDoc":null,"category":"65e89307d046d10030fa2a1c","createdAt":"2023-08-04T13:09:23.570Z","isBodyEmpty":false,"children":[]}]}],"meta":{"title":"Feefo","type":"home"},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.239.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[],"variables":{"user":{},"defaults":[]},"project":{"_id":"56d59dbef612b80b00fb69a7","appearance":{"html_head":"","link_logo_to_url":false,"promos":[{"extras":{"type":"search","buttonPrimary":"","buttonSecondary":""},"title":"Feefo Developer Hub","text":"Welcome to the Feefo developer hub. You'll find comprehensive guides and documentation to help you start working with Feefo as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"56d59dbef612b80b00fb69a8"}],"stylesheet":"","html_footer":"","html_footer_meta":"","hide_logo":true,"html_promo":"","javascript":"","logo_white_use":true,"overlay":"circuits","sticky":false,"colors":{"header_text":"","highlight":"","main":"#fdd100","main_alt":"","body_highlight":"#1b2cf8","custom_login_link_color":""},"header":{"img":["https://files.readme.io/8bd1e15-Feefo_banner_new.png","8bd1e15-Feefo_banner_new.png",1080,300,"#000000","65fd818258be01007535e394"],"style":"overlay","img_pos":"cr","img_size":"cover"},"typography":{"body":"Open+Sans:400:sans-serif","headline":"Open+Sans:400:sans-serif","tk_body":"","tk_headline":"","tk_key":"","typekit":false},"html_hidelinks":false,"body":{"style":"none"},"favicon":["https://files.readme.io/ldWWBKRDRmuxX4MgeGKd_favicon.ico","favicon.ico","32","32","#fce757",""],"logo":["https://files.readme.io/e01f0ec-small-Feefo_logo_white.png","e01f0ec-small-Feefo_logo_white.png",344,80,"#ffffff","https://files.readme.io/dffbe2d-Feefo_logo_white.png","64cb76870731e60035f5d9ea"],"logo_white":["https://files.readme.io/4cac3a4-small-Feefo_logo_colour.png","4cac3a4-small-Feefo_logo_colour.png",344,80,"#000000","https://files.readme.io/d9884c6-Feefo_logo_colour.png","65fd8114fdf8c6004bd98d2f"],"main_body":{"type":"links"},"theme":"solid","html_body":"","landing":true,"showMetricsInReference":true,"childrenAsPills":false,"global_landing_page":{"html":"","redirect":""},"hideTableOfContents":false,"javascript_hub2":"","nextStepsLabel":"","rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"referenceLayout":"row","referenceSimpleMode":true,"showVersion":true,"splitReferenceDocs":false,"stylesheet_hub2":"","stylesheet_hub3":"","subheaderStyle":"dropdown","notheme":false,"colorScheme":"light","loginLogo":[],"logo_large":true,"allowApiExplorerJsonEditor":false,"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false}},"custom_domain":"","childrenProjects":[],"derivedPlan":"business","description":"Explore Feefo's developer knowledge base for expert insights, tutorials, and resources to empower your integration projects. Unlock the potential of Feefo's advanced APIs and tools with our comprehensive developer documentation.","error404":"","experiments":[],"first_page":"landing","flags":{"swagger":false,"autoSslGeneration":true,"correctnewlines":false,"hub2":true,"oauth":false,"newApiExplorer":false,"newSearch":true,"useReactApp":true,"allowApiExplorerJsonEditor":false,"allowXFrame":false,"allow_hub2":false,"alwaysShowDocPublishStatus":false,"dashReact":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"graphql":false,"metricsV2":true,"migrationRun":true,"migrationSwaggerRun":false,"newEditor":true,"newMarkdownBetaProgram":true,"oldMarkdown":false,"rdmdCompatibilityMode":false,"singleProjectEnterprise":false,"speedyRender":false,"staging":false,"translation":false,"disableDiscuss":false,"hideGoogleAnalytics":false,"jwt":false,"stripe":false,"allowDarkMode":false,"disablePasswordlessLogin":false,"newEditorDash":true,"reviewWorkflow":true,"star":false,"useReactGLP":false,"allowReusableOTPs":false,"apiV2":false,"dashQuickstart":false,"git":{"read":false,"write":false},"owlbotAi":false,"superHub":false,"superHubBeta":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"billingRedesignEnabled":true,"disableAutoTranslate":false,"disableSAMLScoping":false,"disableSignups":false,"passwordlessLogin":"default","developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":false},"fullBaseUrl":"https://feefo.readme.io/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"zzfy861q","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"docs","alignment":"left","pageType":"Documentation"},{"type":"docs","alignment":"left","pageType":"Reference"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"planLimit":1000000,"thumbsEnabled":true,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"discuss":false,"blog":true,"reference":true,"examples":true,"docs":true,"landing":true,"changelog":true,"custompages":false,"logs":false,"suggested_edits":true,"tutorials":true,"graphql":false},"name":"Feefo","nav_names":{"discuss":"","blog":"","docs":"","changelog":"","reference":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":true,"api":true,"logs":false,"domain":true,"metricsSDK":true},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"business","planOverride":"business","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":true,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":148},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":true,"defaultExpandResponseSchema":true,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"56d59dbff612b80b00fb69aa","version_clean":"2.0.0","__v":3,"is_hidden":false,"version":"2.0","is_deprecated":false,"is_stable":true,"project":"56d59dbef612b80b00fb69a7","releaseDate":"2016-03-01T13:48:47.363Z","categories":["56d59dbff612b80b00fb69ab","56d5a28ac8c687150071f0e8","56d811e37a04df0b00ddf00d","6376bc8c127d99000313bf86","64ccfc0d6bcd390052462445","64ccfeb975e28e0046189243","65e8695b5d430c004d9dfb4f","65e872b54a57c2001f2c249b","65e87d576608e60011e36525","65e87d8a635bb000180122b9","65e891b45d430c004d9e7e90","65e89212495dd0002be76ad7","65e8924d7bd9d9001bba1021","65e8925ddf8d5f005863411d","65e892634d97af005abc968d","65e8926d1c491800575585bf","65e89307d046d10030fa2a1c","65e8974500881e0012c1867d","65e89c015c54b500479e189b","65e97d7c36776a00307387f3","65e97e9646e21d002e6a654b","65e97fba46e21d002e6a65d5"],"codename":"","createdAt":"2016-03-01T13:48:47.363Z","is_beta":false,"updatedAt":"2024-03-07T08:50:02.831Z","pdfStatus":""},"subdomain":"feefo","subpath":"","superHubWaitlist":false,"topnav":{"edited":true,"left":[{"type":"search"},{"type":"reference","text":"API Reference"},{"type":"url","text":"Support","url":"https://support.feefo.com"}],"right":[{"type":"user","text":"User","url":"/login?redirect_uri=/"}],"bottom":[]},"trial":{"trialDeadlineEnabled":false,"trialEndsAt":"2021-12-02T00:31:50.338Z"},"translate":{"key_public":"","languages":[],"org_name":"","project_name":"","provider":"transifex","show_widget":false},"url":"https://www.feefo.com","versions":[{"_id":"56d59dbff612b80b00fb69aa","version_clean":"2.0.0","__v":3,"is_hidden":false,"version":"2.0","is_deprecated":false,"is_stable":true,"project":"56d59dbef612b80b00fb69a7","releaseDate":"2016-03-01T13:48:47.363Z","categories":["56d59dbff612b80b00fb69ab","56d5a28ac8c687150071f0e8","56d811e37a04df0b00ddf00d","6376bc8c127d99000313bf86","64ccfc0d6bcd390052462445","64ccfeb975e28e0046189243","65e8695b5d430c004d9dfb4f","65e872b54a57c2001f2c249b","65e87d576608e60011e36525","65e87d8a635bb000180122b9","65e891b45d430c004d9e7e90","65e89212495dd0002be76ad7","65e8924d7bd9d9001bba1021","65e8925ddf8d5f005863411d","65e892634d97af005abc968d","65e8926d1c491800575585bf","65e89307d046d10030fa2a1c","65e8974500881e0012c1867d","65e89c015c54b500479e189b","65e97d7c36776a00307387f3","65e97e9646e21d002e6a654b","65e97fba46e21d002e6a65d5"],"codename":"","createdAt":"2016-03-01T13:48:47.363Z","is_beta":false,"updatedAt":"2024-03-07T08:50:02.831Z","pdfStatus":""}],"variableDefaults":[],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[],"canonical_url":null,"description":"Explore Feefo's developer knowledge base for expert insights, tutorials, and resources to empower your integration projects. Unlock the potential of Feefo's advanced APIs and tools with our comprehensive developer documentation.","homepage_url":"https://www.feefo.com","id":"56d59dbef612b80b00fb69a7","is_migrated":false,"name":"Feefo","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"feefo","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"features":{"custom_components":"disabled","mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":false,"metricsSDK":true},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"expanded","response_schemas":"expanded"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2021-12-02T00:31:50.338Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":"zzfy861q","secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"enabled"}}},"appearance":{"brand":{"primary_color":"#fdd100","link_color":"#1b2cf8","theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"hide"},"logo":{"size":"large","dark_mode":{"uri":"/images/65fd8114fdf8c6004bd98d2f","url":"https://files.readme.io/4cac3a4-small-Feefo_logo_colour.png","name":"4cac3a4-small-Feefo_logo_colour.png","width":344,"height":80,"color":"#000000","links":{"original_url":"https://files.readme.io/d9884c6-Feefo_logo_colour.png"}},"main":{"uri":"/images/64cb76870731e60035f5d9ea","url":"https://files.readme.io/e01f0ec-small-Feefo_logo_white.png","name":"e01f0ec-small-Feefo_logo_white.png","width":344,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/dffbe2d-Feefo_logo_white.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/ldWWBKRDRmuxX4MgeGKd_favicon.ico","name":"favicon.ico","width":32,"height":32,"color":"#fce757","links":{"original_url":null}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"overlay","gradient_color":null,"overlay":{"fill":"cover","type":"circuits","position":"center-right","image":{"uri":null,"url":"https://files.readme.io/8bd1e15-Feefo_banner_new.png","name":"8bd1e15-Feefo_banner_new.png","width":1080,"height":300,"color":"#000000","links":{"original_url":"65fd818258be01007535e394"}}}},"navigation":{"first_page":"landing_page","left":[{"type":"search_box","title":null,"url":null,"custom_page":null},{"type":"reference","title":null,"url":null,"custom_page":null},{"type":"link_url","title":"Support","url":"https://support.feefo.com","custom_page":null}],"logo_link":"landing_page","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"sub_nav":[],"subheader_layout":"dropdown","version":"enabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"enabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"56d59dbff612b80b00fb69aa","version_clean":"2.0.0","__v":3,"is_hidden":false,"version":"2.0","is_deprecated":false,"is_stable":true,"project":"56d59dbef612b80b00fb69a7","releaseDate":"2016-03-01T13:48:47.363Z","categories":["56d59dbff612b80b00fb69ab","56d5a28ac8c687150071f0e8","56d811e37a04df0b00ddf00d","6376bc8c127d99000313bf86","64ccfc0d6bcd390052462445","64ccfeb975e28e0046189243","65e8695b5d430c004d9dfb4f","65e872b54a57c2001f2c249b","65e87d576608e60011e36525","65e87d8a635bb000180122b9","65e891b45d430c004d9e7e90","65e89212495dd0002be76ad7","65e8924d7bd9d9001bba1021","65e8925ddf8d5f005863411d","65e892634d97af005abc968d","65e8926d1c491800575585bf","65e89307d046d10030fa2a1c","65e8974500881e0012c1867d","65e89c015c54b500479e189b","65e97d7c36776a00307387f3","65e97e9646e21d002e6a654b","65e97fba46e21d002e6a65d5"],"codename":"","createdAt":"2016-03-01T13:48:47.363Z","is_beta":false,"updatedAt":"2024-03-07T08:50:02.831Z","pdfStatus":""}},"reqUrl":"/","version":{"_id":"56d59dbff612b80b00fb69aa","version_clean":"2.0.0","__v":3,"is_hidden":false,"version":"2.0","is_deprecated":false,"is_stable":true,"project":"56d59dbef612b80b00fb69a7","releaseDate":"2016-03-01T13:48:47.363Z","categories":["56d59dbff612b80b00fb69ab","56d5a28ac8c687150071f0e8","56d811e37a04df0b00ddf00d","6376bc8c127d99000313bf86","64ccfc0d6bcd390052462445","64ccfeb975e28e0046189243","65e8695b5d430c004d9dfb4f","65e872b54a57c2001f2c249b","65e87d576608e60011e36525","65e87d8a635bb000180122b9","65e891b45d430c004d9e7e90","65e89212495dd0002be76ad7","65e8924d7bd9d9001bba1021","65e8925ddf8d5f005863411d","65e892634d97af005abc968d","65e8926d1c491800575585bf","65e89307d046d10030fa2a1c","65e8974500881e0012c1867d","65e89c015c54b500479e189b","65e97d7c36776a00307387f3","65e97e9646e21d002e6a654b","65e97fba46e21d002e6a65d5"],"codename":"","createdAt":"2016-03-01T13:48:47.363Z","is_beta":false,"updatedAt":"2024-03-07T08:50:02.831Z","pdfStatus":""},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,572,5312,2406,2395,6522,7112,73,8263,1282,2852,3880,7783,1456,4935,6841,6722,1936,5798,7971,153,1313,1666,4002,3787,4467,1080,9852,8684,1202,2144,9141,1343,9575,2578,3221,7327,7285,3307,1948,6060,6922,2859,2637,4674,1731,3859,8063,5408,2402,4793,2616,3412,678,7289,3556,7031,8899]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Doc","Footer","routes-Reference","routes-PageNotFound","routes-Landing","routes-Tutorials","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","core-icons-alert-circle-svg","routes-Changelog","Post","core-icons-more-vertical-svg","core-icons-arrow-right-svg","core-icons-eye-off-svg","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx","core-icons-lock-svg","CustomPage","List","core-icons-chevron-down-svg","core-icons-arrow-up-right-svg","routes-Discuss","Page","core-icons-star-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","routes-CustomPage","core-icons-webhook-svg","core-icons-inbox-svg","core-icons-key-svg","core-icons-message-circle-svg","core-graphics-json-svg","New"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.b8520cde412c1642dc0b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2406.951963c0cf542b4b86a4.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/73.535ee2b3bfca871baf6d.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8263.3d098f45b4b562ec80b5.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.49bb02ec5acf87fd228c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.9119a4e00e8cb781f8b7.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6722.386671bc80030984d9c0.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.4f1c8dfacfeed0a6ea87.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.a0c700eb9ae5192d6433.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.18ddfae65f140c2e4c1e.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.3337538299592ef842e6.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.3a8d675d9cf79a25b071.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="core-icons-inbox-svg" src="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"></script></div><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"MjQyODlhYmUxMGQ3NWVjYTllMjhkYjY4ZDY2Nzc3ZDgzZTBjOWZlNzJiZDc2MzJjYzliYzhkN2E2ZGNlZDAwZXRhZ0ZpbHRlcnM9KHByb2plY3Q6NTZkNTlkYmVmNjEyYjgwYjAwZmI2OWE3KSwodmVyc2lvbjpub25lLHZlcnNpb246NTZkNTlkYmZmNjEyYjgwYjAwZmI2OWFhKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2csaW5kZXg6VHV0b3JpYWwp","filters":"tagFilters=(project:56d59dbef612b80b00fb69a7),(version:none,version:56d59dbff612b80b00fb69aa),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog,index:Tutorial)","metaData":[{"modules":{"discuss":false,"blog":true,"reference":true,"examples":true,"docs":true,"landing":true,"changelog":true,"custompages":false,"logs":false,"suggested_edits":true,"tutorials":true,"graphql":false},"id":"56d59dbef612b80b00fb69a7","name":"Feefo","subdomain":"feefo","subpath":"","nav_names":{"discuss":"","blog":"","docs":"","changelog":"","reference":"","tutorials":"","recipes":""}}]},"intercom":{"intercom":"zzfy861q","intercom_secure_emailonly":false}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>

CINXE.COM

Feefo