CINXE.COM
Customer API: Securely Manage Customer Data
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta class="swiftype" name="page_type" data-type="enum" content="techref"/><title>Customer API: Securely Manage Customer Data</title><meta name="description" content="Use customer APIs to securely manage customer data, encourage repeat business, attract new customers, and analyze customer interactions."/><meta name="environment" content="production"/><meta property="og:site_name" content="Square Developer"/><meta property="og:title" content="Customer API: Securely Manage Customer Data"/><meta property="og:description" content="Use customer APIs to securely manage customer data, encourage repeat business, attract new customers, and analyze customer interactions."/><meta property="og:url" content="https://developer.squareup.com/docs/customers"/><meta name="twitter:card" content="summary"/><meta name="twitter:site" content="@SquareDev"/><meta name="twitter:creator" content="@SquareDev"/><meta name="twitter:title" content="Customer API: Securely Manage Customer Data"/><meta name="twitter:url" content="https://developer.squareup.com/docs/customers"/><meta name="twitter:description" content="Use customer APIs to securely manage customer data, encourage repeat business, attract new customers, and analyze customer interactions."/><meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=1"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="canonical" href="https://developer.squareup.com/docs/customers"/><meta name="next-head-count" content="18"/><link rel="preconnect" href="https://dex-tech-fe-production-c.squarecdn.com/main"/><link rel="preconnect" href="https://square-fonts-production-f.squarecdn.com"/><link rel="preload" href="https://square-fonts-production-f.squarecdn.com/square-sans.min.css" as="style"/><link rel="stylesheet" href="https://square-fonts-production-f.squarecdn.com/square-sans.min.css"/><script id="sync-theme-from-storage" integrity="" type="text/javascript" data-nscript="beforeInteractive">var canUseLocalStorage = true; try { window.localStorage } catch (e) { canUseLocalStorage = false } var showDark = !1, storedVal = canUseLocalStorage && window.localStorage.getItem("themeSwitcher-isDark"); (showDark = storedVal ? "true" === storedVal : window.matchMedia && window.matchMedia("(prefers-color-scheme: dark)").matches) && !window.location.pathname.startsWith("/docs") && document.querySelector("html").classList.add("dark"); if(canUseLocalStorage && !storedVal) { window.localStorage.setItem("themeSwitcher-isDark", showDark); }</script><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/70848683cdb9616a.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/70848683cdb9616a.css" data-n-g=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/e8bb7e3362f33eab.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/e8bb7e3362f33eab.css" data-n-p=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/1ee312704ccd3658.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/1ee312704ccd3658.css" data-n-p=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/f46c8bc19c31c913.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/f46c8bc19c31c913.css" data-n-p=""/><link rel="preload" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/ab5910dc57cff66a.css" as="style"/><link rel="stylesheet" href="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/css/ab5910dc57cff66a.css"/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/polyfills-c67a75d1b6f99dc8.js"></script><script id="one-trust" src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" type="text/javascript" data-domain-script="c4657020-c7d1-4a14-a091-267a7ee4863e" defer="" data-nscript="beforeInteractive"></script><script defer="" src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/9726.26dfc224d878abc7.js"></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/webpack-7c5eea35d4f1fb78.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/framework-e3cb3eb2d5f357d8.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/main-6bd61b5a73f90664.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/pages/_app-1a414ec8d41ddcb6.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/32855e9f-1a692ea671250f50.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/6311-971c73fc3e6291d4.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/2924-d3627c1ecc4004cb.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/8834-a2fe10ea1e50d1e4.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/6008-e6bf90c7cb0b44b8.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/8863-504e707da6a9a2bb.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/1402-33f546103c1d75f0.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/1295-101d67a30cba4c23.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/2172-89f2a2e74b732931.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/5576-d465ea75c332db87.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/9962-79649dc6204fcd7d.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/5958-812f26abc3363e73.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/chunks/pages/docs/%5B%5B...slug%5D%5D-a3f43387710e0848.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/45a671e198d332b37aa8aed10a78e8aa8544f793/_buildManifest.js" defer=""></script><script src="https://dex-tech-fe-production-c.squarecdn.com/main/_next/static/45a671e198d332b37aa8aed10a78e8aa8544f793/_ssgManifest.js" defer=""></script></head><body><market-context-manager></market-context-manager><div id="__next"><div id="user-interaction-publisher"><market-toaster></market-toaster><div class="app_app__T4olD"><div class="grid_dex-grid-container__ZLJnB grid_dex-docs-app-grid-container__k80cL page-layout_page-layout__M2lNk page-layout_fixed-layout__hOmlH"><div class="grid-item_grid-item-full__LsU8d page-layout_top-layout__ejnXB"><div class="mobile-nav-helpers_vars__2Xk6M mobile-nav-helpers_shifter__7JF7H mobile-nav-helpers_show-hamburger-tablet__fNdPX"><div><header class="dex-site-header svelte-180r00y slim noPadding" data-swiftype-index="false" type="button" data-test-selector="site-header"><div class="dex-nav__left-nav svelte-180r00y"><button class="dex-site-header__collapse-button dex-site-header__button-reset svelte-180r00y" aria-label="navigation menu"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M2 6a1 1 0 011-1h18a1 1 0 110 2H3a1 1 0 01-1-1zm0 6a1 1 0 011-1h18a1 1 0 110 2H3a1 1 0 01-1-1zm1 5a1 1 0 100 2h18a1 1 0 100-2H3z" fill="var(--dex-nav-nav-hamburger-color)"></path></svg></button> <a class="dex-site-header__link-outer dex-site-header__desktop-nav dex-site-header__logo svelte-180r00y noPadding" href="https://developer.squareup.com" data-test-selector="site-header-square-logo"><div class="dex-site-header__link-inner svelte-180r00y"><div class="dsgn-logo svelte-1afh84a"><svg role="presentation" width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svelte-bffzqn"><path d="M7.526 7.866c-.026.08-.026.179-.026.376v3.516c0 .197 0 .296.026.376a.53.53 0 0 0 .34.34c.08.026.179.026.376.026h3.516c.197 0 .296 0 .376-.026a.53.53 0 0 0 .34-.34c.026-.08.026-.179.026-.376V8.242c0-.197 0-.296-.026-.376a.53.53 0 0 0-.34-.34c-.08-.026-.179-.026-.376-.026H8.242c-.197 0-.296 0-.376.026a.53.53 0 0 0-.34.34z" fill="var(--dex-nav-text-color-primary)"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M0 4c0-.62 0-.929.041-1.188A3.333 3.333 0 0 1 2.811.04C3.072 0 3.382 0 4 0h12c.62 0 .929 0 1.188.041a3.333 3.333 0 0 1 2.771 2.77C20 3.072 20 3.382 20 4v12c0 .62 0 .929-.041 1.188a3.333 3.333 0 0 1-2.77 2.771C16.928 20 16.618 20 16 20H4c-.62 0-.929 0-1.188-.041a3.333 3.333 0 0 1-2.771-2.77C0 16.928 0 16.618 0 16V4zm4 .947C4 4.424 4.424 4 4.947 4h10.106c.523 0 .947.424.947.947v10.106a.947.947 0 0 1-.947.947H4.947A.947.947 0 0 1 4 15.053V4.947z" fill="var(--dex-nav-text-color-primary)"></path></svg></div> <div class="dsgn-logo-text svelte-1afh84a"><svg role="presentation" xmlns="http://www.w3.org/2000/svg" width="164" height="20" fill="none" aria-label="Square Developer" class="svelte-1afh84a"><path d="M16.675 0H3.376C1.483 0 0 1.483 0 3.325v13.299a3.318 3.318 0 0 0 3.325 3.325h13.3a3.318 3.318 0 0 0 3.324-3.325v-13.3C20 1.485 18.517 0 16.675 0Zm-.307 15.294a1.08 1.08 0 0 1-1.074 1.074H4.706a1.08 1.08 0 0 1-1.074-1.074V4.706c0-.614.46-1.074 1.074-1.074h10.64c.562 0 1.022.46 1.022 1.074v10.588Zm-4.245-2.557a.591.591 0 0 0 .614-.614V7.877a.591.591 0 0 0-.614-.614H7.877a.591.591 0 0 0-.614.614v4.246c0 .358.256.614.614.614h4.246Zm13.197-.307h2.2c.102 1.227.92 2.2 2.66 2.2 1.534 0 2.454-.768 2.454-1.893 0-1.075-.716-1.535-2.046-1.842l-1.688-.358c-1.841-.41-3.222-1.586-3.222-3.53 0-2.148 1.892-3.58 4.348-3.58 2.608 0 4.296 1.381 4.399 3.376h-2.098c-.255-.92-1.023-1.534-2.301-1.534-1.33 0-2.251.716-2.251 1.636 0 .921.818 1.484 2.2 1.79l1.687.359c1.842.409 3.07 1.534 3.07 3.478 0 2.455-1.842 3.939-4.502 3.939-3.12.102-4.757-1.535-4.91-4.041ZM42.455 20v-3.632l.154-1.585h-.154c-.511 1.125-1.534 1.79-2.966 1.79-2.302 0-3.99-1.893-3.99-4.757 0-2.865 1.688-4.757 3.99-4.757 1.432 0 2.404.665 2.966 1.688h.154V7.212H44.5V19.95h-2.046V20Zm.051-8.184C42.506 9.974 41.381 8.9 40 8.9c-1.381 0-2.506 1.074-2.506 2.916 0 1.841 1.125 2.915 2.506 2.915 1.381 0 2.506-1.074 2.506-2.915Zm3.479.92V7.213h2.046v5.32c0 1.432.716 2.148 1.841 2.148 1.432 0 2.353-1.023 2.353-2.608v-4.86h2.046v9.156H52.38v-1.892h-.154c-.46 1.227-1.432 2.046-2.967 2.046-2.148.05-3.273-1.381-3.273-3.785Zm9.514 1.075c0-1.688 1.176-2.711 3.325-2.814l2.506-.153v-.716c0-.87-.614-1.381-1.74-1.381-1.022 0-1.636.511-1.79 1.227h-2.045c.204-1.841 1.739-2.915 3.836-2.915 2.353 0 3.785 1.023 3.785 2.915v6.394h-1.893V14.68h-.153c-.41 1.126-1.33 1.893-3.018 1.893-1.637 0-2.813-1.125-2.813-2.762Zm5.831-1.126v-.46l-2.046.154c-1.125.05-1.586.46-1.586 1.278 0 .716.563 1.177 1.381 1.177 1.433 0 2.251-.921 2.251-2.149Zm3.58 3.683V7.212h1.893v1.74h.154c.255-1.177 1.176-1.74 2.557-1.74h.92v1.842h-1.176c-1.33 0-2.301.87-2.301 2.455v4.86H64.91Zm14.783-4.194h-6.956c.102 1.688 1.278 2.609 2.608 2.609 1.126 0 1.79-.46 2.2-1.177h1.995c-.563 1.842-2.2 2.967-4.246 2.967-2.71 0-4.603-1.995-4.603-4.757 0-2.711 1.943-4.757 4.603-4.757 2.66 0 4.45 1.841 4.45 4.143 0 .41 0 .665-.05.972Zm-1.944-1.381c-.05-1.279-1.125-2.148-2.404-2.148-1.227 0-2.25.767-2.455 2.148h4.86ZM84.962 16.368V3.888h3.99c3.631 0 6.086 2.301 6.086 6.24 0 3.938-2.455 6.24-6.087 6.24h-3.99Zm2.148-1.892h1.841c2.302 0 3.99-1.484 3.99-4.348 0-2.865-1.688-4.348-3.99-4.348H87.11v8.696ZM104.962 12.174h-6.957c.103 1.688 1.279 2.609 2.609 2.609 1.125 0 1.79-.46 2.199-1.177h1.995c-.562 1.842-2.199 2.967-4.245 2.967-2.711 0-4.604-1.995-4.604-4.757 0-2.762 1.944-4.757 4.604-4.757s4.45 1.841 4.45 4.143c.051.41 0 .665-.051.972Zm-1.944-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.228 0-2.25.767-2.455 2.148h4.859ZM108.389 16.368l-3.223-9.156h2.251l1.841 5.473.307 1.28h.154l.358-1.28 1.841-5.473h2.251l-3.376 9.156h-2.404ZM123.12 12.174h-6.956c.102 1.688 1.279 2.609 2.608 2.609 1.126 0 1.791-.46 2.2-1.177h1.995c-.563 1.842-2.2 2.967-4.246 2.967-2.711 0-4.603-1.995-4.603-4.757 0-2.762 1.943-4.757 4.603-4.757 2.66 0 4.45 1.841 4.45 4.143 0 .41-.051.665-.051.972Zm-1.995-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.227 0-2.25.767-2.455 2.148h4.859ZM124.348 16.368V3.683h2.046v12.685h-2.046ZM127.57 11.816c0-2.762 1.842-4.757 4.604-4.757s4.552 1.944 4.552 4.757c0 2.813-1.841 4.757-4.552 4.757-2.813 0-4.604-1.995-4.604-4.757Zm7.059 0c0-1.893-1.125-2.916-2.506-2.916-1.381 0-2.507 1.023-2.507 2.916 0 1.892 1.126 2.915 2.507 2.915 1.381 0 2.506-1.023 2.506-2.915ZM137.903 7.263h1.893v1.535h.153c.563-1.074 1.534-1.74 2.967-1.74 2.302 0 3.989 1.893 3.989 4.758 0 2.864-1.687 4.757-3.989 4.757-1.433 0-2.456-.665-2.967-1.688h-.153l.153 1.534v3.376h-2.046V7.263Zm6.956 4.553c0-1.842-1.125-2.916-2.506-2.916-1.381 0-2.506 1.074-2.506 2.916 0 1.841 1.125 2.915 2.506 2.915 1.381 0 2.506-1.074 2.506-2.915ZM156.829 12.174h-6.957c.103 1.688 1.279 2.609 2.609 2.609 1.125 0 1.79-.46 2.199-1.177h1.995c-.562 1.842-2.199 2.967-4.245 2.967-2.711 0-4.604-1.995-4.604-4.757 0-2.762 1.944-4.757 4.604-4.757s4.45 1.841 4.45 4.143c0 .41-.051.665-.051.972Zm-1.944-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.228 0-2.251.767-2.455 2.148h4.859ZM158.056 16.368V7.263h1.893v1.74h.153c.256-1.177 1.177-1.74 2.558-1.74h.921v1.842h-1.177c-1.33 0-2.302.87-2.302 2.455v4.808h-2.046Z" fill="var(--dex-nav-logo-color-primary)"></path></svg> </div></div></a> <button class="dex-site-header__link-outer dex-site-header__mobile-nav dex-site-header__button-reset svelte-180r00y"><div class="dex-site-header__link-inner svelte-180r00y"><div class="dsgn-logo svelte-1afh84a"><svg role="presentation" width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svelte-bffzqn"><path d="M7.526 7.866c-.026.08-.026.179-.026.376v3.516c0 .197 0 .296.026.376a.53.53 0 0 0 .34.34c.08.026.179.026.376.026h3.516c.197 0 .296 0 .376-.026a.53.53 0 0 0 .34-.34c.026-.08.026-.179.026-.376V8.242c0-.197 0-.296-.026-.376a.53.53 0 0 0-.34-.34c-.08-.026-.179-.026-.376-.026H8.242c-.197 0-.296 0-.376.026a.53.53 0 0 0-.34.34z" fill="var(--dex-nav-text-color-primary)"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M0 4c0-.62 0-.929.041-1.188A3.333 3.333 0 0 1 2.811.04C3.072 0 3.382 0 4 0h12c.62 0 .929 0 1.188.041a3.333 3.333 0 0 1 2.771 2.77C20 3.072 20 3.382 20 4v12c0 .62 0 .929-.041 1.188a3.333 3.333 0 0 1-2.77 2.771C16.928 20 16.618 20 16 20H4c-.62 0-.929 0-1.188-.041a3.333 3.333 0 0 1-2.771-2.77C0 16.928 0 16.618 0 16V4zm4 .947C4 4.424 4.424 4 4.947 4h10.106c.523 0 .947.424.947.947v10.106a.947.947 0 0 1-.947.947H4.947A.947.947 0 0 1 4 15.053V4.947z" fill="var(--dex-nav-text-color-primary)"></path></svg></div> <div class="dsgn-logo-text svelte-1afh84a"><svg role="presentation" xmlns="http://www.w3.org/2000/svg" width="164" height="20" fill="none" aria-label="Square Developer" class="svelte-1afh84a"><path d="M16.675 0H3.376C1.483 0 0 1.483 0 3.325v13.299a3.318 3.318 0 0 0 3.325 3.325h13.3a3.318 3.318 0 0 0 3.324-3.325v-13.3C20 1.485 18.517 0 16.675 0Zm-.307 15.294a1.08 1.08 0 0 1-1.074 1.074H4.706a1.08 1.08 0 0 1-1.074-1.074V4.706c0-.614.46-1.074 1.074-1.074h10.64c.562 0 1.022.46 1.022 1.074v10.588Zm-4.245-2.557a.591.591 0 0 0 .614-.614V7.877a.591.591 0 0 0-.614-.614H7.877a.591.591 0 0 0-.614.614v4.246c0 .358.256.614.614.614h4.246Zm13.197-.307h2.2c.102 1.227.92 2.2 2.66 2.2 1.534 0 2.454-.768 2.454-1.893 0-1.075-.716-1.535-2.046-1.842l-1.688-.358c-1.841-.41-3.222-1.586-3.222-3.53 0-2.148 1.892-3.58 4.348-3.58 2.608 0 4.296 1.381 4.399 3.376h-2.098c-.255-.92-1.023-1.534-2.301-1.534-1.33 0-2.251.716-2.251 1.636 0 .921.818 1.484 2.2 1.79l1.687.359c1.842.409 3.07 1.534 3.07 3.478 0 2.455-1.842 3.939-4.502 3.939-3.12.102-4.757-1.535-4.91-4.041ZM42.455 20v-3.632l.154-1.585h-.154c-.511 1.125-1.534 1.79-2.966 1.79-2.302 0-3.99-1.893-3.99-4.757 0-2.865 1.688-4.757 3.99-4.757 1.432 0 2.404.665 2.966 1.688h.154V7.212H44.5V19.95h-2.046V20Zm.051-8.184C42.506 9.974 41.381 8.9 40 8.9c-1.381 0-2.506 1.074-2.506 2.916 0 1.841 1.125 2.915 2.506 2.915 1.381 0 2.506-1.074 2.506-2.915Zm3.479.92V7.213h2.046v5.32c0 1.432.716 2.148 1.841 2.148 1.432 0 2.353-1.023 2.353-2.608v-4.86h2.046v9.156H52.38v-1.892h-.154c-.46 1.227-1.432 2.046-2.967 2.046-2.148.05-3.273-1.381-3.273-3.785Zm9.514 1.075c0-1.688 1.176-2.711 3.325-2.814l2.506-.153v-.716c0-.87-.614-1.381-1.74-1.381-1.022 0-1.636.511-1.79 1.227h-2.045c.204-1.841 1.739-2.915 3.836-2.915 2.353 0 3.785 1.023 3.785 2.915v6.394h-1.893V14.68h-.153c-.41 1.126-1.33 1.893-3.018 1.893-1.637 0-2.813-1.125-2.813-2.762Zm5.831-1.126v-.46l-2.046.154c-1.125.05-1.586.46-1.586 1.278 0 .716.563 1.177 1.381 1.177 1.433 0 2.251-.921 2.251-2.149Zm3.58 3.683V7.212h1.893v1.74h.154c.255-1.177 1.176-1.74 2.557-1.74h.92v1.842h-1.176c-1.33 0-2.301.87-2.301 2.455v4.86H64.91Zm14.783-4.194h-6.956c.102 1.688 1.278 2.609 2.608 2.609 1.126 0 1.79-.46 2.2-1.177h1.995c-.563 1.842-2.2 2.967-4.246 2.967-2.71 0-4.603-1.995-4.603-4.757 0-2.711 1.943-4.757 4.603-4.757 2.66 0 4.45 1.841 4.45 4.143 0 .41 0 .665-.05.972Zm-1.944-1.381c-.05-1.279-1.125-2.148-2.404-2.148-1.227 0-2.25.767-2.455 2.148h4.86ZM84.962 16.368V3.888h3.99c3.631 0 6.086 2.301 6.086 6.24 0 3.938-2.455 6.24-6.087 6.24h-3.99Zm2.148-1.892h1.841c2.302 0 3.99-1.484 3.99-4.348 0-2.865-1.688-4.348-3.99-4.348H87.11v8.696ZM104.962 12.174h-6.957c.103 1.688 1.279 2.609 2.609 2.609 1.125 0 1.79-.46 2.199-1.177h1.995c-.562 1.842-2.199 2.967-4.245 2.967-2.711 0-4.604-1.995-4.604-4.757 0-2.762 1.944-4.757 4.604-4.757s4.45 1.841 4.45 4.143c.051.41 0 .665-.051.972Zm-1.944-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.228 0-2.25.767-2.455 2.148h4.859ZM108.389 16.368l-3.223-9.156h2.251l1.841 5.473.307 1.28h.154l.358-1.28 1.841-5.473h2.251l-3.376 9.156h-2.404ZM123.12 12.174h-6.956c.102 1.688 1.279 2.609 2.608 2.609 1.126 0 1.791-.46 2.2-1.177h1.995c-.563 1.842-2.2 2.967-4.246 2.967-2.711 0-4.603-1.995-4.603-4.757 0-2.762 1.943-4.757 4.603-4.757 2.66 0 4.45 1.841 4.45 4.143 0 .41-.051.665-.051.972Zm-1.995-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.227 0-2.25.767-2.455 2.148h4.859ZM124.348 16.368V3.683h2.046v12.685h-2.046ZM127.57 11.816c0-2.762 1.842-4.757 4.604-4.757s4.552 1.944 4.552 4.757c0 2.813-1.841 4.757-4.552 4.757-2.813 0-4.604-1.995-4.604-4.757Zm7.059 0c0-1.893-1.125-2.916-2.506-2.916-1.381 0-2.507 1.023-2.507 2.916 0 1.892 1.126 2.915 2.507 2.915 1.381 0 2.506-1.023 2.506-2.915ZM137.903 7.263h1.893v1.535h.153c.563-1.074 1.534-1.74 2.967-1.74 2.302 0 3.989 1.893 3.989 4.758 0 2.864-1.687 4.757-3.989 4.757-1.433 0-2.456-.665-2.967-1.688h-.153l.153 1.534v3.376h-2.046V7.263Zm6.956 4.553c0-1.842-1.125-2.916-2.506-2.916-1.381 0-2.506 1.074-2.506 2.916 0 1.841 1.125 2.915 2.506 2.915 1.381 0 2.506-1.074 2.506-2.915ZM156.829 12.174h-6.957c.103 1.688 1.279 2.609 2.609 2.609 1.125 0 1.79-.46 2.199-1.177h1.995c-.562 1.842-2.199 2.967-4.245 2.967-2.711 0-4.604-1.995-4.604-4.757 0-2.762 1.944-4.757 4.604-4.757s4.45 1.841 4.45 4.143c0 .41-.051.665-.051.972Zm-1.944-1.381c-.051-1.279-1.125-2.148-2.404-2.148-1.228 0-2.251.767-2.455 2.148h4.859ZM158.056 16.368V7.263h1.893v1.74h.153c.256-1.177 1.177-1.74 2.558-1.74h.921v1.842h-1.177c-1.33 0-2.302.87-2.302 2.455v4.808h-2.046Z" fill="var(--dex-nav-logo-color-primary)"></path></svg> </div> <span class="chevron svelte-180r00y"><svg class="direction--down svelte-mcdwxn" width="10" height="12" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 4l4 4 4-4" stroke="var(--dex-nav-icon-color)" stroke-width="2" stroke-linecap="round"></path></svg></span></div></button></div> <div class="dex-site-header__search-container svelte-180r00y"><button class="dsgn__search-button svelte-ezc5q8" data-test-selector="search-button"><svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" fill="none"><path fill="var(--dex-nav-text-color-primary)" fill-opacity=".9" d="M5 9.667a4.639 4.639 0 0 0 2.787-.934l2.74 2.74.94-.94-2.74-2.74a4.61 4.61 0 0 0 .933-2.786A4.672 4.672 0 0 0 4.993.34 4.672 4.672 0 0 0 .327 5.007c0 2.573 2.1 4.66 4.673 4.66Zm0-8a3.335 3.335 0 0 1 0 6.666 3.335 3.335 0 0 1 0-6.666Z"></path></svg> <span class="dsgn-search__desktop-view dsgn-search__button-text svelte-ezc5q8">Search developer resources</span> <div data-testid="search-hot-key" class="dsgn-search__desktop-view dsgn-search__button-hotkey-container svelte-ezc5q8"><div class="dsgn-search__desktop-view dsgn-search__button-hotkey-text svelte-ezc5q8">/ </div></div> </button></div> <ul class="dex-site-header__right-nav svelte-180r00y"><li class="dex-site-header__desktop-nav svelte-180r00y"><button class="dsgn__dropdown-button svelte-1dsehf1 highlighted">Docs & Tools</button> </li> <li class="dex-site-header__desktop-nav svelte-180r00y"><button class="dsgn__dropdown-button svelte-1dsehf1">SDKs</button> </li> <li class="dex-site-header__desktop-nav svelte-180r00y"><button class="dsgn__dropdown-button svelte-1dsehf1">Support</button> </li> <li class="dex-site-header__desktop-nav svelte-180r00y"><a data-test-selector="site-header-partnerships-link" class="dex-site-header__right-nav__link dex-site-header__link-outer svelte-180r00y" href="https://www.squareup.com/us/en/partnerships">Partnerships </a></li> <li class="dex-site-header__desktop-nav svelte-180r00y"><a data-test-selector="site-header-sign-in-link" class="dex-site-header__right-nav__link dex-site-header__link-outer sign-in-link svelte-180r00y" href="https://squareup.com/login?app=developer&return_to=https://developer.squareup.com/apps">Sign In </a></li> <li class="dex-site-header__mobile-nav svelte-180r00y"><a data-test-selector="site-header-sign-in-link" class="dex-site-header__right-nav__link dex-site-header__link-outer sign-in-link svelte-180r00y" href="https://squareup.com/login?app=developer&return_to=https://developer.squareup.com/apps">Sign In </a></li></ul></header> </div></div></div><div class="grid-item_grid-item-full__LsU8d"><div data-testid="top-nav-desktop" class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_b-t-l-std__qC_VL box_b-b-l-std__q5XI3 top-nav_top-nav__aG_ui top-nav_desktop__iLo1X"><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Docs Home"}" href="/docs" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Docs Home</a><div data-testid="top-nav-divider" class="box_m-l-075x__tnNb9 box_m-r-075x__gXUwj top-nav-items_divider__VVpS8"></div><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Dev Essentials"}" href="/docs/development-essentials" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Dev Essentials</a><div data-testid="top-nav-divider" class="box_m-l-075x__tnNb9 box_m-r-075x__gXUwj top-nav-items_divider__VVpS8"></div><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Payments"}" href="/docs/payments-overview" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Payments</a><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Commerce"}" href="/docs/commerce" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Commerce</a><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Customers"}" href="/docs/customers" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI top-nav-items_active__uF7_5 focus-ring-styles_focus-ring__5P6v0">Customers</a><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Staff"}" href="/docs/staff" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Staff</a><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Merchants"}" href="/docs/merchant-details" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Merchants</a><div data-testid="top-nav-divider" class="box_m-l-075x__tnNb9 box_m-r-075x__gXUwj top-nav-items_divider__VVpS8"></div><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Publish"}" href="/docs/app-marketplace" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Publish</a><div data-testid="top-nav-space" class="top-nav-items_space__H5jum"></div><div data-testid="top-nav-divider" class="box_m-l-075x__tnNb9 box_m-r-075x__gXUwj top-nav-items_divider__VVpS8"></div><a data-tracking-id="top-nav-link" data-tracking-extra="{"title":"Release notes"}" href="/docs/release-notes" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy top-nav-items_link__YZ4rI focus-ring-styles_focus-ring__5P6v0">Release notes</a></div></div><div data-testid="docs-mobile-nav" class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-3x__w9FzI box_p-b-3x__BcYHb mobile-nav_mobile-nav__VSQOx"><div class="mobile-nav_top__U5ub2"><div><h2 data-testid="mobile-nav-title" class="heading_base__MS64u heading_heading-30__MH4YZ">Docs</h2></div><button data-tracking-id="docs-mobile-nav-close-button" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 mobile-nav_close-button__q8KNd"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="m6.71 18.71 5.29-5.3 5.29 5.3 1.42-1.42-5.3-5.29 5.3-5.29-1.42-1.42-5.29 5.3-5.29-5.3-1.42 1.42 5.3 5.29-5.3 5.29 1.42 1.42Z" fill="#7B61FF"></path></svg></button></div><div class="box_m-t-7x__d2nuT"><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Docs Home</a></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/development-essentials" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Dev Essentials</a><button data-tracking-id="mobile-nav-step-into" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/payments-overview" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Payments</a><button data-tracking-id="mobile-nav-step-into" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/commerce" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Commerce</a><button data-tracking-id="mobile-nav-step-into" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/customers" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe mobile-nav_active__23Zu_">Customers</a><button data-tracking-id="mobile-nav-step-into" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/staff" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Staff</a><button data-tracking-id="mobile-nav-step-into" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/merchant-details" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Merchants</a><button data-tracking-id="mobile-nav-step-into" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/app-marketplace" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Publish</a><button data-tracking-id="mobile-nav-step-into" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></button></div><div data-testid="mobile-nav-item" class="box_m-t-2x__WfWa6 box_m-b-2x__nVJGZ box_p-b-2x__bSkd6 box_b-b-l-std__q5XI3 mobile-nav_nav-item__d7rgv"><a href="/docs/release-notes" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy mobile-nav_link__k_jYe">Release notes</a><button data-tracking-id="mobile-nav-step-into" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m5 4.586 4 4-4 4L6.414 14l5.414-5.414-5.414-5.414L5 4.586Z" fill="currentColor"></path></svg></button></div></div></div></div><div data-testid="left-layout" class="page-layout_page-layout__M2lNk page-layout_fixed-layout__hOmlH page-layout_left-layout__rxzHd"><button data-testid="left-nav-toggle" data-tracking-id="left-nav-toggle" aria-label="Toggle left navigation" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 left-nav_left-nav-toggle__M_yBT"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="24" viewBox="0 0 16 12" fill="none"><path fill="#7B61FF" fill-rule="evenodd" d="M0.292893 5.29282L5.29289 0.292818L6.70711 1.70703L3.41421 4.99992L6.5 4.99992L11.5 4.99992L11.5 6.99992L6.5 6.99992L3.41421 6.99992L6.70711 10.2928L5.29289 11.707L0.292893 6.70703C-0.0976315 6.31651 -0.0976315 5.68334 0.292893 5.29282ZM16 -6.99382e-07L14 -6.11959e-07L14 12L16 12L16 -6.99382e-07Z" clip-rule="evenodd"></path></svg></button><div data-testid="left-nav" class="box_p-l-3x__N7Usx box_p-r-3x__0IVNa box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-l-std__Q4dy4 left-nav_left-nav__tj2rk"><div class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Overview"}" id="left-nav-active-item" href="/docs/customers" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_active__X6xck left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Overview</a></div><div aria-expanded="false" aria-controls=":R59l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Technical Scenarios"}" href="/docs/customers/scenarios" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Technical Scenarios</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R59l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Build a Tip Report"}" href="/docs/customers/scenarios/tip-reporting" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Build a Tip Report</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Split an Online Payment"}" href="/docs/customers/scenarios/split-online-payment" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Split an Online Payment</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Build a Sales Report"}" href="/docs/customers/scenarios/simple-sales-report" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Build a Sales Report</a></div></div></div><div aria-expanded="false" aria-controls=":R79l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customers"}" href="/docs/customers-api/what-it-does" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Customers</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R79l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customers API Workflows"}" href="/docs/customers-api/how-it-works" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Customers API Workflows</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Customer Profiles"}" href="/docs/customers-api/use-the-api/keep-records" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Customer Profiles</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Retrieve Customer Profiles"}" href="/docs/customers-api/use-the-api/retrieve-profiles" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Retrieve Customer Profiles</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Search for Customer Profiles"}" href="/docs/customers-api/use-the-api/search-customers" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Search for Customer Profiles</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Integrate with Other Services"}" href="/docs/customers-api/use-the-api/integrate-with-other-services" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Integrate with Other Services</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use Customer Webhooks"}" href="/docs/customers-api/use-the-api/customer-webhooks" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Use Customer Webhooks</a></div></div></div><div aria-expanded="false" aria-controls=":R99l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customer Custom Attributes"}" href="/docs/customer-custom-attributes-api/overview" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Customer Custom Attributes</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R99l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Customer Custom Attribute Definitions"}" href="/docs/customer-custom-attributes-api/custom-attribute-definitions" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Customer Custom Attribute Definitions</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Customer Custom Attributes"}" href="/docs/customer-custom-attributes-api/custom-attributes" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Customer Custom Attributes</a></div></div></div><div aria-expanded="false" aria-controls=":Rb9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customer Groups"}" href="/docs/customer-groups-api/what-it-does" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Customer Groups</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":Rb9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use Customer Groups"}" href="/docs/customer-groups-api/how-to-use-it" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Use Customer Groups</a></div></div></div><div aria-expanded="false" aria-controls=":Rd9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Customer Segments"}" href="/docs/customer-segments-api/what-it-does" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Customer Segments</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":Rd9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use Customer Segments"}" href="/docs/customer-segments-api/how-to-use-it" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Use Customer Segments</a></div></div></div><div aria-expanded="false" aria-controls=":Rf9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Loyalty"}" href="/docs/loyalty-api/overview" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Loyalty</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":Rf9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Loyalty Program Overview"}" href="/docs/loyalty/overview" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Loyalty Program Overview</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Retrieve Loyalty Program"}" href="/docs/loyalty-api/loyalty-programs" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Retrieve Loyalty Program</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Loyalty Promotions"}" href="/docs/loyalty-api/loyalty-promotions" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Loyalty Promotions</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Create and Retrieve Loyalty Accounts"}" href="/docs/loyalty-api/loyalty-accounts" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Create and Retrieve Loyalty Accounts</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Loyalty Points"}" href="/docs/loyalty-api/loyalty-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Loyalty Points</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Loyalty Rewards"}" href="/docs/loyalty-api/loyalty-rewards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Loyalty Rewards</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Search for Loyalty Events"}" href="/docs/loyalty-api/loyalty-events" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Search for Loyalty Events</a></div><div aria-expanded="false" aria-controls=":R25f9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_inner-sub-cat__ngiQT"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Loyalty Walkthrough 1"}" href="/docs/loyalty-api/walkthrough1" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Loyalty Walkthrough 1</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R25f9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Set up a Loyalty Program"}" href="/docs/loyalty-api/walkthrough1/setup-loyalty-program" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Set up a Loyalty Program</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Enroll a Buyer"}" href="/docs/loyalty-api/walkthrough1/enroll-buyer" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Enroll a Buyer</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Accumulate Points"}" href="/docs/loyalty-api/walkthrough1/accrue-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Accumulate Points</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Redeem Points"}" href="/docs/loyalty-api/walkthrough1/redeem-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Redeem Points</a></div></div></div><div aria-expanded="false" aria-controls=":R2df9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_inner-sub-cat__ngiQT"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Loyalty Walkthrough 2"}" href="/docs/loyalty-api/walkthrough2" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Loyalty Walkthrough 2</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R2df9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Set up a Loyalty Program"}" href="/docs/loyalty-api/walkthrough2-setup-loyalty-program" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Set up a Loyalty Program</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Enroll a Buyer"}" href="/docs/loyalty-api/walkthrough2-enroll-buyer" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Enroll a Buyer</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Adjust Points"}" href="/docs/loyalty-api/walkthrough2-accrue-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Adjust Points</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Redeem Points"}" href="/docs/loyalty-api/walkthrough2-redeem-points" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Redeem Points</a></div></div></div></div></div><div aria-expanded="false" aria-controls=":Rh9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_top-level__aAjx6"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Gift Cards"}" href="/docs/gift-cards/using-gift-cards-api" class="text_base__bZ6a4 text_paragraph-30___agDz text_medium-30__U9kB2 left-nav-items_link__skoFI left-nav-items_top-level__zpAn3 focus-ring-styles_focus-ring__5P6v0">Gift Cards</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":Rh9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Sell Gift Cards"}" href="/docs/gift-cards/sell-gift-cards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Sell Gift Cards</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Reload Gift Cards"}" href="/docs/gift-cards/reload-gift-cards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Reload Gift Cards</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Redeem Gift Cards"}" href="/docs/gift-cards/redeem-gift-cards" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Redeem Gift Cards</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Retrieve Gift Cards and Track Activity"}" href="/docs/gift-cards/retrieve-gift-cards-and-activities" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Retrieve Gift Cards and Track Activity</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Manage Gift Cards on File"}" href="/docs/gift-cards/manage-gift-cards-on-file" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Manage Gift Cards on File</a></div><div aria-expanded="false" aria-controls=":R1lh9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_inner-sub-cat__ngiQT"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Walkthrough 1: Sell a Gift Card"}" href="/docs/gift-cards/walkthrough-1" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Walkthrough 1: Sell a Gift Card</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R1lh9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Sell a Gift Card (Orders API Integration)"}" href="/docs/gift-cards/walkthrough-1-with-orders-api" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Sell a Gift Card (Orders API Integration)</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Sell a Gift Card (Custom Processing System)"}" href="/docs/gift-cards/walkthrough-1-without-orders-api" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Sell a Gift Card (Custom Processing System)</a></div></div></div><div aria-expanded="false" aria-controls=":R1th9l6:" class="recursive-nav-item_nav-item-wrap__7yT4s recursive-nav-item_inner-sub-cat__ngiQT"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Walkthrough 2: Use a Gift Card"}" href="/docs/gift-cards/walkthrough-2" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Walkthrough 2: Use a Gift Card</a><button data-testid="expand-nav-items" data-tracking-id="expand-nav-items" aria-label="Expand navigation items" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 recursive-nav-item_expand-button__OaGCd"><svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="m4 4.586 4 4 4-4L13.414 6 8 11.414 2.586 6 4 4.586Z" fill="#7B61FF"></path></svg></button></div><div id=":R1th9l6:" inert="true" role="region" class="recursive-nav-item_items-container__BBrAQ"><div class="recursive-nav-item_content__WNo9i"><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use a Gift Card (Orders and Payments APIs Integration)"}" href="/docs/gift-cards/walkthrough-2-orders-and-payments-integration" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Use a Gift Card (Orders and Payments APIs Integration)</a></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Use a Gift Card (Custom Processing System)"}" href="/docs/gift-cards/walkthrough-2-custom-processing-system" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0"><span class="left-nav-items_depth-space__b597h"></span>Use a Gift Card (Custom Processing System)</a></div></div></div><div class="recursive-nav-item_nav-item-wrap__7yT4s"><a data-tracking-id="left-nav-link" data-tracking-extra="{"title":"Webhooks"}" href="/docs/gift-cards/webhooks" class="text_base__bZ6a4 text_paragraph-20__2lYBq text_medium-20__UlBGy left-nav-items_link__skoFI left-nav-items_sub-level__bbmd6 focus-ring-styles_focus-ring__5P6v0">Webhooks</a></div></div></div></div></div><div class="grid_dex-grid-container__ZLJnB grid_dex-docs-app-grid-container__k80cL page-layout_page-layout__M2lNk page-layout_static-layout__CfHWZ"><div class="grid-item_grid-item-small__Xb5VI page-layout_left-nav__gfhJ2"></div><div class="box_m-t-6x__LvLNv box_m-b-6x__RhdjX page-layout_page-main__W1JTS grid-item_grid-item-medium__GhKvB"><div data-testid="docs-content-layout" class="grid_dex-grid-container__ZLJnB grid_dex-docs-content-grid-container__diyxN"><div class="page-layout_content-main-grid-item__VRqbw page-layout_grid-item-column-autosizing__PtGh2 grid-item_grid-item-full__LsU8d"><h1 data-testid="doc-page-heading" class="box_m-b-3x__A9ryy heading_base__MS64u heading_display-10__HZsS7 content_heading__9PVgB">Customer APIs</h1><div><div><article data-testid="markdown-doc" data-page-type="landing" class="text_base__bZ6a4 text_paragraph-30___agDz nodes_article__2nMA2 nodes_landing__3hNZ5 nodes_pink__QXAq5"><div class="box_m-b-8x__RDJyi doc-page-banner_banner__vTXMD"><div class="doc-page-banner_banner-image__99rLo doc-page-banner_custom-image__ygZhM"><div data-testid="doc-animation-customers" class="animations_grid__JiEEv animations_container__IOWr2 animations_customers__DxlDM icon_icon-fill-current-color__IXS7u"><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M19 7h-2.18c.11-.31.18-.65.18-1 0-1.65-1.35-3-3-3-.77 0-1.47.3-2 .78-.53-.48-1.23-.78-2-.78-1.65 0-3 1.35-3 3 0 .35.07.69.18 1H5c-1.66 0-3 1.34-3 3v8c0 1.66 1.34 3 3 3h14c1.66 0 3-1.34 3-3v-8c0-1.66-1.34-3-3-3Zm1 3v3h-7v-2.59l1.29 1.29 1.41-1.41L14.41 9H19c.55 0 1 .45 1 1Zm-6-5c.55 0 1 .45 1 1s-.45 1-1 1h-1V6c0-.55.45-1 1-1ZM9 6c0-.55.45-1 1-1s1 .45 1 1v1h-1c-.55 0-1-.45-1-1ZM5 9h4.59L8.3 10.29l1.41 1.41L11 10.41V13H4v-3c0-.55.45-1 1-1Zm0 10c-.55 0-1-.45-1-1v-3h7v4H5Zm14 0h-6v-4h7v3c0 .55-.45 1-1 1Z" fill="#000"></path></svg><div data-order="8" class="animations_dot__KcP1i animations_left__jjtgQ"></div><div data-order="7" class="animations_dot__KcP1i animations_right__esRXH"></div></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M5 7a4 4 0 1 1 8 0 4 4 0 0 1-8 0Zm4-2a2 2 0 1 0 0 4 2 2 0 0 0 0-4Z" fill="#000"></path><path d="M17.997 11V8h2v3h3v2h-3v3h-2v-3h-3v-2h3ZM3 21a6 6 0 0 1 12 0h2a8 8 0 1 0-16 0h2Z" fill="#000"></path></svg><div data-order="1" class="animations_dot__KcP1i animations_left__jjtgQ"></div><div data-order="3" class="animations_dot__KcP1i animations_top__3fMhH"></div></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M5.478 16.495a2.5 2.5 0 0 1-1.414-4.243l5.142-5.141 2.829 2.828a1 1 0 0 0 1.414 0l.161-.161a1 1 0 0 0 0-1.415l-2.828-2.828a3 3 0 0 0-4.243 0L3.144 8.93a2.198 2.198 0 0 0 0 3.11L1.73 13.452a4.198 4.198 0 0 1 0-5.937l3.395-3.395a5 5 0 0 1 7.071 0 5 5 0 0 1 7.071 0l2.829 2.828a5 5 0 0 1 0 7.071l-8.132 8.132a2.5 2.5 0 0 1-4.243-1.414 2.49 2.49 0 0 1-1.414-.707 2.489 2.489 0 0 1-.707-1.415 2.489 2.489 0 0 1-1.414-.707 2.489 2.489 0 0 1-.708-1.414Zm8.133-10.96a3 3 0 0 1 4.242 0l2.829 2.828a3 3 0 0 1 0 4.243l-8.132 8.132a.5.5 0 0 1-.712-.702l2.48-2.48-1.415-1.415-2.475 2.475-.004.005a.5.5 0 0 1-.703-.712l2.475-2.474-1.414-1.415-2.475 2.475a.5.5 0 0 1-.715-.699l.008-.008 2.475-2.475L8.66 11.9l-2.474 2.475a.5.5 0 1 1-.707-.707l3.727-3.728 1.414 1.414a3 3 0 0 0 4.243 0l.162-.161a3 3 0 0 0 0-4.243L13.61 5.535Z" fill="#000"></path></svg><div data-order="6" class="animations_dot__KcP1i animations_top__3fMhH"></div><div data-order="5" class="animations_dot__KcP1i animations_right__esRXH"></div></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M17.64 20.87 12 17.75l-5.64 3.12 1.08-6.6-4.51-4.62 6.23-.95L12 2.65l2.84 6.05 6.23.95-4.51 4.62 1.08 6.6ZM12 15.47l3.01 1.66-.58-3.53 2.49-2.56-3.44-.53L12 7.35l-1.48 3.16-3.44.53 2.49 2.56-.58 3.53L12 15.47Z" fill="#000"></path></svg><div data-order="4" class="animations_dot__KcP1i animations_left__jjtgQ"></div><div data-order="2" class="animations_dot__KcP1i animations_bottom__xuUqi"></div></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><div class="animations_square__D_1sv"></div><svg height="2" class="animations_line__cVbYW" style="top:31px;left:-78px" width="400px"><line x1="0" y1="1" x2="400" y2="1" stroke="currentColor" stoke-width="2"></line></svg><svg class="animations_line__cVbYW" style="top:112px;left:351px" height="500" width="700"><path d="M130 1L17 1C8.16344 1 1 8.16344 1 17L1 51" stroke="currentColor"></path></svg><svg width="2" class="animations_line__cVbYW" style="top:224px;left:511px" height="110px"><line x1="1" y1="0" x2="1" y2="100" stroke="currentColor" stoke-width="2"></line></svg><svg height="2" class="animations_line__cVbYW" style="top:191px;left:382px" width="100px"><line x1="0" y1="1" x2="98" y2="1" stroke="currentColor" stoke-width="2"></line></svg><svg class="animations_line__cVbYW" style="top:31px;left:382px" height="500" width="700"><path d="M130 48L130 17C130 8.16344 122.837 1 114 0.999999L2.6226e-06 0.999994" stroke="currentColor"></path></svg><div class="animations_shim__WoGcJ animations_shim-right__n6q9u"></div><div class="animations_shim__WoGcJ animations_shim-bottom__j5Zz6"></div><div class="animations_shim__WoGcJ animations_shim-left__E9CVI"></div></div></div><div class="doc-page-banner_content__NRFCB"><p>The <span slot="trigger"><a data-tracking-id="markdown-link" href="/docs/homepage" class="nodes_markdown-link__1J6_a">Square Developer platform</a></span> provides customer APIs to build applications that help sellers grow their businesses through strong customer relationships. Use the customer APIs to securely manage customer data, analyze buying behavior, and integrate engagement features to increase repeat business and attract new customers.</p></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#square-products" id="square-products" aria-label="anchor link for square-products" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for square-products" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Square products</h2></div></div><p>Sellers can access and manage customer features from a variety of Square products.</p><div data-testid="tabset" role="tablist" class="box_m-b-4x__jr_IJ tab_tabset__c44HM markdown-tabset_tabset__G8lmz"><div class="box_b-t-l-std__qC_VL tab_tabset-underline__Wu7oW"></div><div class="tab_tabset-item__6fS_h tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"Customer Directory"}" role="tab" aria-label="Customer Directory" aria-selected="true" aria-controls="customer-directory-panel" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7 tab_selected__c2f_5">Customer Directory</p></button><div class="box_b-tl-r-6__3cnv8 box_b-tr-r-6__P9jUr box_b-bl-r-6__Z_gEo tab_underline__AUKDk"></div></div><div class="tab_tabset-item__6fS_h tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"Square Loyalty"}" role="tab" aria-label="Square Loyalty" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7">Square Loyalty</p></button></div><div class="tab_tabset-item__6fS_h tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"Square Marketing"}" role="tab" aria-label="Square Marketing" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7">Square Marketing</p></button></div><div class="tab_tabset-item__6fS_h tab_last__LmwSF tab_small__K59MB"><button data-testid="tabset-item" data-tracking-id="tabset-item" data-tracking-extra="{"label":"Square Gift Cards"}" role="tab" aria-label="Square Gift Cards" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0"><p class="box_p-b-1x__E6rAE text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R text_color-20__myvq7">Square Gift Cards</p></button></div></div><div role="tabpanel" id="customer-directory-panel"><div data-testid="markdown-tab-Customer Directory" style="--markdown-tab-image-height:258px" class="box_m-t-3x__rN_qC markdown-tabset_tab__0c8OW markdown-tabset_has-image___ZhFU"><div><div data-testid="doc-card-desktop" class="box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy markdown-card_card___ZokO markdown-card_in-tab__E_ak0"><div class="doc-card_content__yPX79 doc-card_border__r_iES"><p>A free CRM software built into all Square payment tools where sellers can store information about their customers, analyze how they interact with their business, and actively engage with them.</p><p>With access to customer data like purchase history or loyalty status, sellers can understand their customers better and make smarter business decisions.</p><p><a data-testid="doc-card-link-out" href="https://squareup.com/point-of-sale/features/customer-directory" class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R doc-card_doc-card-link-out__3A3iE focus-ring-styles_focus-ring__5P6v0 markdown-card_card-link-out__IKhWn">Learn about Square Customer Directory<svg width="13" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" class="doc-card_link-out-icon__cnlux icon_icon-fill-current-color__IXS7u"><path d="M9.086 6 4.793 1.707 6.207.293l6 6a1 1 0 0 1 0 1.414l-6 6-1.414-1.414L9.086 8H0V6h9.086Z" fill="#005AD9"></path></svg></a></p></div></div></div><div class="markdown-tabset_col2__AyU8e"><img alt="tab-image" loading="lazy" width="444" height="258" decoding="async" data-nimg="1" class="markdown-tabset_tabImage__razYK" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/7alC3HJ4L6aZxdSnCwqYNl/d230ffe4b9f684466f9440c6de86cfbc/Customer_Directory.png?fm=webp&w=640&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/7alC3HJ4L6aZxdSnCwqYNl/d230ffe4b9f684466f9440c6de86cfbc/Customer_Directory.png?fm=webp&w=1080&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/7alC3HJ4L6aZxdSnCwqYNl/d230ffe4b9f684466f9440c6de86cfbc/Customer_Directory.png?fm=webp&w=1080&q=75"/></div></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#build-with-customer-apis" id="build-with-customer-apis" aria-label="anchor link for build-with-customer-apis" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for build-with-customer-apis" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Build with customer APIs</h2></div></div><p>Use the following APIs to integrate customer management and engagement features in your application.</p><div data-testid="card-layout-desktop" class="box_m-t-2x__WfWa6 markdown-layout_layout__ACQDr markdown-layout_grid__j4QGo markdown-layout_row__z2d8a markdown-layout_start__bTRcC responsive-helpers_tablet-grid__1WZPh responsive-helpers_desktop-grid__MV0sd markdown-card_card-layout__PL6rP markdown-card_grid__bU0qB markdown-card_row__vfcU8"><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Customers API" href="/docs/customers-api/what-it-does" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/2n9wYQoxTE2HMbiRIz0dV3/2bd828e6ee20dadb22bee170b372649b/handshake-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/2n9wYQoxTE2HMbiRIz0dV3/2bd828e6ee20dadb22bee170b372649b/handshake-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/2n9wYQoxTE2HMbiRIz0dV3/2bd828e6ee20dadb22bee170b372649b/handshake-pink.svg?w=48&q=75"/><p><strong>Customers API</strong></p><p>Manage customer profiles and group membership, search the directory, and sync records with CRM systems.</p></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Customer Custom Attributes API" href="/docs/customer-custom-attributes-api/overview" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/y2tdQtshsIVHX7LzYkJmA/9329b9a538548058e0e1a2e07e5a45db/human-plus-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/y2tdQtshsIVHX7LzYkJmA/9329b9a538548058e0e1a2e07e5a45db/human-plus-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/y2tdQtshsIVHX7LzYkJmA/9329b9a538548058e0e1a2e07e5a45db/human-plus-pink.svg?w=48&q=75"/><p><strong>Customer Custom Attributes API</strong></p><p>Define custom properties for customer profiles to unlock customization scenarios.</p></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Customer Groups API" href="/docs/customer-groups-api/what-it-does" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/1JfMCY2zHULCJ6GRtZPdag/cfdf428ef30f29b3b392031534173811/folder-human-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/1JfMCY2zHULCJ6GRtZPdag/cfdf428ef30f29b3b392031534173811/folder-human-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/1JfMCY2zHULCJ6GRtZPdag/cfdf428ef30f29b3b392031534173811/folder-human-pink.svg?w=48&q=75"/><p><strong>Customer Groups API</strong></p><p>Create groups to enable scoped promotions at scale and actions based on group membership.</p></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Customer Segments API" href="/docs/customer-segments-api/what-it-does" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/2z1cjORz0gn6LHtlHxMnWy/d8a98bb6207c2797dd315fab8f600551/chart-bar.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/2z1cjORz0gn6LHtlHxMnWy/d8a98bb6207c2797dd315fab8f600551/chart-bar.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/2z1cjORz0gn6LHtlHxMnWy/d8a98bb6207c2797dd315fab8f600551/chart-bar.svg?w=48&q=75"/><p><strong>Customer Segments API</strong></p><p>Get basic details about segments that filter customers by buying behavior and other traits.</p></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Loyalty API" href="/docs/loyalty-api/overview" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/4CsZC276gjnS9bH1n9h38R/162873614dd6aa84367bbbb515efd014/star-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/4CsZC276gjnS9bH1n9h38R/162873614dd6aa84367bbbb515efd014/star-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/4CsZC276gjnS9bH1n9h38R/162873614dd6aa84367bbbb515efd014/star-pink.svg?w=48&q=75"/><p><strong>Loyalty API</strong></p><p>Create accounts and promotions and let buyers earn points and redeem reward discounts.</p></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Gift Cards API" href="/docs/gift-cards/using-gift-cards-api" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/70ZFClu9PFZ4DZ2H4eTlCr/d83c4efe2e9bbf5b1223b9cd98283d57/gift-card-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/70ZFClu9PFZ4DZ2H4eTlCr/d83c4efe2e9bbf5b1223b9cd98283d57/gift-card-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/70ZFClu9PFZ4DZ2H4eTlCr/d83c4efe2e9bbf5b1223b9cd98283d57/gift-card-pink.svg?w=48&q=75"/><p><strong>Gift Cards API</strong></p><p>Create and activate gift cards, reload card balances, and track gift card activities.</p></div></div></div><div data-testid="card-layout-narrow" class="box_m-t-2x__WfWa6 markdown-layout_layout__ACQDr markdown-layout_grid__j4QGo markdown-layout_col__5Y2xT markdown-layout_start__bTRcC responsive-helpers_narrow-grid__WwM_u markdown-card_card-layout__PL6rP markdown-card_grid__bU0qB markdown-card_col__t0dnU"><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Customers API" href="/docs/customers-api/what-it-does" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/2n9wYQoxTE2HMbiRIz0dV3/2bd828e6ee20dadb22bee170b372649b/handshake-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/2n9wYQoxTE2HMbiRIz0dV3/2bd828e6ee20dadb22bee170b372649b/handshake-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/2n9wYQoxTE2HMbiRIz0dV3/2bd828e6ee20dadb22bee170b372649b/handshake-pink.svg?w=48&q=75"/><p><strong>Customers API</strong></p><p>Manage customer profiles and group membership, search the directory, and sync records with CRM systems.</p></div></div><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Customer Custom Attributes API" href="/docs/customer-custom-attributes-api/overview" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/y2tdQtshsIVHX7LzYkJmA/9329b9a538548058e0e1a2e07e5a45db/human-plus-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/y2tdQtshsIVHX7LzYkJmA/9329b9a538548058e0e1a2e07e5a45db/human-plus-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/y2tdQtshsIVHX7LzYkJmA/9329b9a538548058e0e1a2e07e5a45db/human-plus-pink.svg?w=48&q=75"/><p><strong>Customer Custom Attributes API</strong></p><p>Define custom properties for customer profiles to unlock customization scenarios.</p></div></div><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Customer Groups API" href="/docs/customer-groups-api/what-it-does" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/1JfMCY2zHULCJ6GRtZPdag/cfdf428ef30f29b3b392031534173811/folder-human-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/1JfMCY2zHULCJ6GRtZPdag/cfdf428ef30f29b3b392031534173811/folder-human-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/1JfMCY2zHULCJ6GRtZPdag/cfdf428ef30f29b3b392031534173811/folder-human-pink.svg?w=48&q=75"/><p><strong>Customer Groups API</strong></p><p>Create groups to enable scoped promotions at scale and actions based on group membership.</p></div></div><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Customer Segments API" href="/docs/customer-segments-api/what-it-does" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/2z1cjORz0gn6LHtlHxMnWy/d8a98bb6207c2797dd315fab8f600551/chart-bar.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/2z1cjORz0gn6LHtlHxMnWy/d8a98bb6207c2797dd315fab8f600551/chart-bar.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/2z1cjORz0gn6LHtlHxMnWy/d8a98bb6207c2797dd315fab8f600551/chart-bar.svg?w=48&q=75"/><p><strong>Customer Segments API</strong></p><p>Get basic details about segments that filter customers by buying behavior and other traits.</p></div></div><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Loyalty API" href="/docs/loyalty-api/overview" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/4CsZC276gjnS9bH1n9h38R/162873614dd6aa84367bbbb515efd014/star-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/4CsZC276gjnS9bH1n9h38R/162873614dd6aa84367bbbb515efd014/star-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/4CsZC276gjnS9bH1n9h38R/162873614dd6aa84367bbbb515efd014/star-pink.svg?w=48&q=75"/><p><strong>Loyalty API</strong></p><p>Create accounts and promotions and let buyers earn points and redeem reward discounts.</p></div></div><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_darken__76sQA doc-card_small__6QMop markdown-card_card___ZokO"><a data-testid="markdown-card-anchor" aria-label="Gift Cards API" href="/docs/gift-cards/using-gift-cards-api" class="doc-card_doc-card-anchor__9TrZg focus-ring-styles_focus-ring__5P6v0"></a><div class="doc-card_content__yPX79 doc-card_border__r_iES"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/70ZFClu9PFZ4DZ2H4eTlCr/d83c4efe2e9bbf5b1223b9cd98283d57/gift-card-pink.svg?w=32&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/70ZFClu9PFZ4DZ2H4eTlCr/d83c4efe2e9bbf5b1223b9cd98283d57/gift-card-pink.svg?w=48&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/70ZFClu9PFZ4DZ2H4eTlCr/d83c4efe2e9bbf5b1223b9cd98283d57/gift-card-pink.svg?w=48&q=75"/><p><strong>Gift Cards API</strong></p><p>Create and activate gift cards, reload card balances, and track gift card activities.</p></div></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#customer-sample-applications" id="customer-sample-applications" aria-label="anchor link for customer-sample-applications" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for customer-sample-applications" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Customer sample applications</h2></div></div><p>Get up and running quickly with Square customer APIs and see the APIs in action.</p><div data-testid="card-layout-desktop" class="box_m-t-2x__WfWa6 markdown-layout_layout__ACQDr markdown-layout_grid__j4QGo markdown-layout_row__z2d8a markdown-layout_start__bTRcC responsive-helpers_tablet-grid__1WZPh responsive-helpers_desktop-grid__MV0sd markdown-card_card-layout__PL6rP markdown-card_grid__bU0qB markdown-card_row__vfcU8"><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79 doc-card_border__r_iES"><p><strong>Gift Cards API Sample</strong></p><p>Shows how to sell and reload gift cards, link customers, view activity history, and generate barcodes.</p><div data-name="icon-container-grid" class="box_m-t-2x__WfWa6 markdown-internal-grid_grid__jaW9H"><div class="icon-container_icon-container__PMF3H"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" src="//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg"/><p><strong><span slot="trigger"><a data-tracking-id="markdown-link" href="https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_gift-cards" class="nodes_markdown-link__1J6_a">Node.js</a></span></strong></p></div></div></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79 doc-card_border__r_iES"><p><strong>Order-Ahead Sample</strong></p><p>Lets buyers place online orders, choose delivery options, earn loyalty points, and pay for an order.</p><div data-name="icon-container-grid" class="box_m-t-2x__WfWa6 markdown-internal-grid_grid__jaW9H"><div class="icon-container_icon-container__PMF3H"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" src="//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg"/><p><strong><span slot="trigger"><a data-tracking-id="markdown-link" href="https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_orders-payments" class="nodes_markdown-link__1J6_a">Node.js</a></span></strong></p></div></div></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79 doc-card_border__r_iES"><p><strong>Bookings API Sample</strong></p><p>Checks availability and books an appointment for a customer with a team member.</p><div data-name="icon-container-grid" class="box_m-t-2x__WfWa6 markdown-internal-grid_grid__jaW9H"><div class="icon-container_icon-container__PMF3H"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" src="//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg"/><p><strong><span slot="trigger"><a data-tracking-id="markdown-link" href="https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_bookings" class="nodes_markdown-link__1J6_a">Node.js</a></span></strong></p></div></div></div></div></div><div data-testid="card-layout-narrow" class="box_m-t-2x__WfWa6 markdown-layout_layout__ACQDr markdown-layout_grid__j4QGo markdown-layout_col__5Y2xT markdown-layout_start__bTRcC responsive-helpers_narrow-grid__WwM_u markdown-card_card-layout__PL6rP markdown-card_grid__bU0qB markdown-card_col__t0dnU"><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79 doc-card_border__r_iES"><p><strong>Gift Cards API Sample</strong></p><p>Shows how to sell and reload gift cards, link customers, view activity history, and generate barcodes.</p><div data-name="icon-container-grid" class="box_m-t-2x__WfWa6 markdown-internal-grid_grid__jaW9H"><div class="icon-container_icon-container__PMF3H"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" src="//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg"/><p><strong><span slot="trigger"><a data-tracking-id="markdown-link" href="https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_gift-cards" class="nodes_markdown-link__1J6_a">Node.js</a></span></strong></p></div></div></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79 doc-card_border__r_iES"><p><strong>Order-Ahead Sample</strong></p><p>Lets buyers place online orders, choose delivery options, earn loyalty points, and pay for an order.</p><div data-name="icon-container-grid" class="box_m-t-2x__WfWa6 markdown-internal-grid_grid__jaW9H"><div class="icon-container_icon-container__PMF3H"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" src="//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg"/><p><strong><span slot="trigger"><a data-tracking-id="markdown-link" href="https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_orders-payments" class="nodes_markdown-link__1J6_a">Node.js</a></span></strong></p></div></div></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79 doc-card_border__r_iES"><p><strong>Bookings API Sample</strong></p><p>Checks availability and books an appointment for a customer with a team member.</p><div data-name="icon-container-grid" class="box_m-t-2x__WfWa6 markdown-internal-grid_grid__jaW9H"><div class="icon-container_icon-container__PMF3H"><img alt="icon" loading="lazy" width="24" height="24" decoding="async" data-nimg="1" style="color:transparent" src="//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg"/><p><strong><span slot="trigger"><a data-tracking-id="markdown-link" href="https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_bookings" class="nodes_markdown-link__1J6_a">Node.js</a></span></strong></p></div></div></div></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#customer-guides" id="customer-guides" aria-label="anchor link for customer-guides" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for customer-guides" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Customer guides</h2></div></div><p>Learn about commonly used features and tasks you can do with customer APIs.</p><div data-testid="carousel" class="box_m-t-4x__FOwYa carousel_container__jGA8f carousel_shims__PQBVZ shim_setup__H8zAG shim_light__FC_fD markdown-carousel_carousel__wlGTK"><div class="carousel_carousel__n567V"><a data-testid="carousel-card-customers-api/use-the-api/keep-records" href="/docs/customers-api/use-the-api/keep-records" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-6__eFn6m text_base__bZ6a4 text_paragraph-30___agDz carousel_card__khykk focus-ring-styles_focus-ring__5P6v0"><p class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Manage Customer Profiles</p>Create, update, and delete customer profiles in a seller's Customer Directory.</a> <a data-testid="carousel-card-loyalty-api/loyalty-rewards" href="/docs/loyalty-api/loyalty-rewards" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-6__eFn6m text_base__bZ6a4 text_paragraph-30___agDz carousel_card__khykk focus-ring-styles_focus-ring__5P6v0"><p class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Manage Loyalty Rewards</p>Create and manage loyalty rewards that allow buyers to redeem points for discounts.</a> <a data-testid="carousel-card-gift-cards/sell-gift-cards" href="/docs/gift-cards/sell-gift-cards" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-6__eFn6m text_base__bZ6a4 text_paragraph-30___agDz carousel_card__khykk focus-ring-styles_focus-ring__5P6v0"><p class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Sell Square Gift Cards</p>Create and activate a gift card that can be used at any of the seller's locations.</a> <a data-testid="carousel-card-customers-api/use-the-api/search-customers" href="/docs/customers-api/use-the-api/search-customers" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-l-std__hNqJW box_b-r-6__eFn6m text_base__bZ6a4 text_paragraph-30___agDz carousel_card__khykk focus-ring-styles_focus-ring__5P6v0"><p class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R">Search for Customer Profiles</p>Search the Customer Directory by phone number, email address, and other attributes.</a></div></div><div data-markdown-heading="2" class="box_m-t-5x__L06CC box_m-b-2x__nVJGZ"><a href="#extend-customers-with-other-api-groups" id="extend-customers-with-other-api-groups" aria-label="anchor link for extend-customers-with-other-api-groups" class="anchored-heading_anchor__JhuiX"></a><div class="anchored-heading_heading__2wlPu"><div class="anchored-heading_container__rfGXv"><market-tooltip popover-placement="top-start" style="--tooltip-minimum-width:0px;--tooltip-minimum-height:0px"><a data-tracking-id="heading-anchor" role="link" tabindex="0" slot="trigger" aria-label="click to copy link for extend-customers-with-other-api-groups" class="box_b-r-6__eFn6m native-button_button__Iabj1 native-button_no-border__LHOho native-button_button-padding__xncbB focus-ring-styles_focus-ring__5P6v0 anchored-heading_trigger__XOE12 anchored-heading_button__TMpy8"><svg width="16" height="16" viewBox="0 0 16 16" class="anchored-heading_icon__4HlYl"><path d="M10.432 1.032c-.641.093-.887.239-1.099.649-.056.109-.07.184-.071.391-.001.229.009.276.097.455a.921.921 0 0 0 .486.471c.198.092.446.102.849.035.807-.133 1.657.312 2.034 1.065.161.321.212.538.212.9 0 .361-.05.573-.216.916-.122.254-.131.262-1.778 1.91C9.299 9.471 9.29 9.48 9.036 9.602c-.375.182-.572.223-.988.207-.538-.021-.887-.163-1.303-.533-.259-.23-.453-.312-.741-.313a.971.971 0 0 0-.681.263c-.2.18-.29.382-.304.684-.017.354.065.54.365.829.502.484 1.096.81 1.797.986.424.107 1.137.133 1.589.059.366-.06.832-.209 1.141-.364.549-.276.665-.378 2.46-2.172 1.462-1.462 1.725-1.738 1.886-1.982.483-.732.692-1.417.692-2.269 0-1.11-.398-2.063-1.189-2.844a3.97 3.97 0 0 0-2.019-1.074 4.553 4.553 0 0 0-1.309-.047M6.93 3.694a4.276 4.276 0 0 0-1.955.778c-.103.074-.931.877-1.839 1.786C1.352 8.041 1.242 8.167.959 8.75c-.171.354-.25.583-.336.974-.083.379-.088 1.156-.011 1.518.34 1.59 1.458 2.767 2.996 3.155.256.065.401.081.835.093 1.025.028 1.494-.153 1.731-.666a.786.786 0 0 0 .082-.411.753.753 0 0 0-.098-.426 1.004 1.004 0 0 0-.482-.476c-.157-.077-.462-.089-.897-.036-.628.078-1.179-.115-1.645-.575a1.563 1.563 0 0 1-.354-.495c-.3-.608-.3-1.185-.001-1.799l.14-.285 1.64-1.639c1.567-1.566 1.65-1.644 1.88-1.761.34-.173.568-.228.946-.228.525 0 .954.164 1.36.522.293.257.404.307.714.323.234.012.277.005.442-.069.226-.101.452-.331.533-.54.084-.22.078-.58-.014-.787-.128-.287-.727-.792-1.249-1.053-.64-.319-1.553-.48-2.241-.395" fill-rule="evenodd"></path></svg></a><span slot="content">Link to section</span></market-tooltip></div><h2 class="heading_base__MS64u heading_heading-30__MH4YZ">Extend customers with other API groups</h2></div></div><p>Combine customer features with other Square APIs to build engagements across all areas of a seller's business and see buyer trends.</p><div data-testid="card-layout-desktop" class="box_m-t-2x__WfWa6 markdown-layout_layout__ACQDr markdown-layout_grid__j4QGo markdown-layout_row__z2d8a markdown-layout_start__bTRcC responsive-helpers_tablet-grid__1WZPh responsive-helpers_desktop-grid__MV0sd markdown-card_card-layout__PL6rP markdown-card_grid__bU0qB markdown-card_row__vfcU8"><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79"><img alt="icon" loading="lazy" width="149" height="96" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/6F8p3hDRca8fhlPkqJHBnQ/1fa527dd360f527d904c55e949c67a91/paymentsxcustomers.svg?w=256&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/6F8p3hDRca8fhlPkqJHBnQ/1fa527dd360f527d904c55e949c67a91/paymentsxcustomers.svg?w=384&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/6F8p3hDRca8fhlPkqJHBnQ/1fa527dd360f527d904c55e949c67a91/paymentsxcustomers.svg?w=384&q=75"/><p><strong>Payments 脳 Customers</strong></p><p>Link customers to payment flows, subscriptions, and invoices and take gift card payments with automatic redemption.</p><p><a data-testid="doc-card-link-out" href="/docs/payments-overview" class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R doc-card_doc-card-link-out__3A3iE focus-ring-styles_focus-ring__5P6v0 markdown-card_card-link-out__IKhWn">Payment APIs<svg width="13" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" class="doc-card_link-out-icon__cnlux icon_icon-fill-current-color__IXS7u"><path d="M9.086 6 4.793 1.707 6.207.293l6 6a1 1 0 0 1 0 1.414l-6 6-1.414-1.414L9.086 8H0V6h9.086Z" fill="#005AD9"></path></svg></a></p></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79"><img alt="icon" loading="lazy" width="149" height="96" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/6phgVDg7Gs3CkWFok2kAm8/345988546b5e8cce5917a6411fa14af0/commercexcustomers.svg?w=256&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/6phgVDg7Gs3CkWFok2kAm8/345988546b5e8cce5917a6411fa14af0/commercexcustomers.svg?w=384&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/6phgVDg7Gs3CkWFok2kAm8/345988546b5e8cce5917a6411fa14af0/commercexcustomers.svg?w=384&q=75"/><p><strong>Commerce 脳 Customers</strong></p><p>Integrate with orders, a catalog, and bookings and use simplified flows for loyalty and gift cards.</p><p><a data-testid="doc-card-link-out" href="/docs/commerce" class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R doc-card_doc-card-link-out__3A3iE focus-ring-styles_focus-ring__5P6v0 markdown-card_card-link-out__IKhWn">Commerce APIs<svg width="13" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" class="doc-card_link-out-icon__cnlux icon_icon-fill-current-color__IXS7u"><path d="M9.086 6 4.793 1.707 6.207.293l6 6a1 1 0 0 1 0 1.414l-6 6-1.414-1.414L9.086 8H0V6h9.086Z" fill="#005AD9"></path></svg></a></p></div></div><div data-testid="doc-card-desktop" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79"><img alt="icon" loading="lazy" width="149" height="96" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/5hLSU3wWta0bTzEdvj997a/99ec6c64ce38471b415c9ae2cf89371d/staffxcustomers.svg?w=256&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/5hLSU3wWta0bTzEdvj997a/99ec6c64ce38471b415c9ae2cf89371d/staffxcustomers.svg?w=384&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/5hLSU3wWta0bTzEdvj997a/99ec6c64ce38471b415c9ae2cf89371d/staffxcustomers.svg?w=384&q=75"/><p><strong>Staff 脳 Customers</strong></p><p>Connect regular customers with favorite team members through payments and bookings.</p><p><a data-testid="doc-card-link-out" href="/docs/staff" class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R doc-card_doc-card-link-out__3A3iE focus-ring-styles_focus-ring__5P6v0 markdown-card_card-link-out__IKhWn">Staff APIs<svg width="13" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" class="doc-card_link-out-icon__cnlux icon_icon-fill-current-color__IXS7u"><path d="M9.086 6 4.793 1.707 6.207.293l6 6a1 1 0 0 1 0 1.414l-6 6-1.414-1.414L9.086 8H0V6h9.086Z" fill="#005AD9"></path></svg></a></p></div></div></div><div data-testid="card-layout-narrow" class="box_m-t-2x__WfWa6 markdown-layout_layout__ACQDr markdown-layout_grid__j4QGo markdown-layout_col__5Y2xT markdown-layout_start__bTRcC responsive-helpers_narrow-grid__WwM_u markdown-card_card-layout__PL6rP markdown-card_grid__bU0qB markdown-card_col__t0dnU"><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79"><img alt="icon" loading="lazy" width="149" height="96" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/6F8p3hDRca8fhlPkqJHBnQ/1fa527dd360f527d904c55e949c67a91/paymentsxcustomers.svg?w=256&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/6F8p3hDRca8fhlPkqJHBnQ/1fa527dd360f527d904c55e949c67a91/paymentsxcustomers.svg?w=384&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/6F8p3hDRca8fhlPkqJHBnQ/1fa527dd360f527d904c55e949c67a91/paymentsxcustomers.svg?w=384&q=75"/><p><strong>Payments 脳 Customers</strong></p><p>Link customers to payment flows, subscriptions, and invoices and take gift card payments with automatic redemption.</p><p><a data-testid="doc-card-link-out" href="/docs/payments-overview" class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R doc-card_doc-card-link-out__3A3iE focus-ring-styles_focus-ring__5P6v0 markdown-card_card-link-out__IKhWn">Payment APIs<svg width="13" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" class="doc-card_link-out-icon__cnlux icon_icon-fill-current-color__IXS7u"><path d="M9.086 6 4.793 1.707 6.207.293l6 6a1 1 0 0 1 0 1.414l-6 6-1.414-1.414L9.086 8H0V6h9.086Z" fill="#005AD9"></path></svg></a></p></div></div><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79"><img alt="icon" loading="lazy" width="149" height="96" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/6phgVDg7Gs3CkWFok2kAm8/345988546b5e8cce5917a6411fa14af0/commercexcustomers.svg?w=256&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/6phgVDg7Gs3CkWFok2kAm8/345988546b5e8cce5917a6411fa14af0/commercexcustomers.svg?w=384&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/6phgVDg7Gs3CkWFok2kAm8/345988546b5e8cce5917a6411fa14af0/commercexcustomers.svg?w=384&q=75"/><p><strong>Commerce 脳 Customers</strong></p><p>Integrate with orders, a catalog, and bookings and use simplified flows for loyalty and gift cards.</p><p><a data-testid="doc-card-link-out" href="/docs/commerce" class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R doc-card_doc-card-link-out__3A3iE focus-ring-styles_focus-ring__5P6v0 markdown-card_card-link-out__IKhWn">Commerce APIs<svg width="13" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" class="doc-card_link-out-icon__cnlux icon_icon-fill-current-color__IXS7u"><path d="M9.086 6 4.793 1.707 6.207.293l6 6a1 1 0 0 1 0 1.414l-6 6-1.414-1.414L9.086 8H0V6h9.086Z" fill="#005AD9"></path></svg></a></p></div></div><div data-testid="doc-card-narrow" class="box_p-l-2x__0A2_9 box_p-r-2x__z29W6 box_p-t-2x__M5RH8 box_p-b-2x__bSkd6 box_b-r-6__eFn6m doc-card_doc-card__wyQhG doc-card_in-grid__2oTUy doc-card_small__6QMop markdown-card_card___ZokO"><div class="doc-card_content__yPX79"><img alt="icon" loading="lazy" width="149" height="96" decoding="async" data-nimg="1" style="color:transparent" srcSet="https://images.ctfassets.net/1nw4q0oohfju/5hLSU3wWta0bTzEdvj997a/99ec6c64ce38471b415c9ae2cf89371d/staffxcustomers.svg?w=256&q=75 1x, https://images.ctfassets.net/1nw4q0oohfju/5hLSU3wWta0bTzEdvj997a/99ec6c64ce38471b415c9ae2cf89371d/staffxcustomers.svg?w=384&q=75 2x" src="https://images.ctfassets.net/1nw4q0oohfju/5hLSU3wWta0bTzEdvj997a/99ec6c64ce38471b415c9ae2cf89371d/staffxcustomers.svg?w=384&q=75"/><p><strong>Staff 脳 Customers</strong></p><p>Connect regular customers with favorite team members through payments and bookings.</p><p><a data-testid="doc-card-link-out" href="/docs/staff" class="text_base__bZ6a4 text_paragraph-30___agDz text_semi-bold-30__Z4S5R doc-card_doc-card-link-out__3A3iE focus-ring-styles_focus-ring__5P6v0 markdown-card_card-link-out__IKhWn">Staff APIs<svg width="13" height="14" fill="none" xmlns="http://www.w3.org/2000/svg" class="doc-card_link-out-icon__cnlux icon_icon-fill-current-color__IXS7u"><path d="M9.086 6 4.793 1.707 6.207.293l6 6a1 1 0 0 1 0 1.414l-6 6-1.414-1.414L9.086 8H0V6h9.086Z" fill="#005AD9"></path></svg></a></p></div></div></div></article></div></div></div><div class="grid-item_grid-item-across__H4lqX"><div data-testid="docs-feedback-prompt" class="box_p-t-8x__SI6nV box_p-b-2x__bSkd6 box_b-t-l-10__Aa_Rv doc-feedback-prompt_container__E7_8O"><div class="box_m-b-2x__nVJGZ"><div class="feedback-widget_large__PmiLi"><div></div></div></div><article data-testid="markdown-doc" class="text_base__bZ6a4 text_paragraph-30___agDz nodes_article__2nMA2"><p>If you need more assistance, contact <span slot="trigger"><a data-tracking-id="markdown-link" href="https://squareup.com/help/contact?panel=BF53A9C8EF68" class="nodes_markdown-link__1J6_a">Developer and App Marketplace Support</a></span> or ask for help in the <span slot="trigger"><a data-tracking-id="markdown-link" href="https://developer.squareup.com/forums" class="nodes_markdown-link__1J6_a">Developer Forums</a></span>.</p></article></div></div></div><div class="grid_dex-grid-container__ZLJnB grid_dex-docs-content-grid-container__diyxN"><div class="box_m-t-10x__IyRMt box_m-b-10x__CM1Qo page-layout_footer__qY_8T"><div><div class="footer-wrapper svelte-ytvx2v"><footer class="dex-site-footer svelte-ytvx2v" data-swiftype-index="false"><div class="dex-site-footer__section svelte-ytvx2v"><div class="dex-site-footer__section__heading__title svelte-ytvx2v" data-test-site-footer-section-title="Development">Development </div> <ul class="dex-site-footer__section__links svelte-ytvx2v"><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/docs" data-test-site-footer-section-link="Guides" class="svelte-ytvx2v">Guides</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/reference/square" data-test-site-footer-section-link="API Reference" class="svelte-ytvx2v">API Reference</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/explorer" data-test-site-footer-section-link="API Explorer" class="svelte-ytvx2v">API Explorer</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/docs/sdks" data-test-site-footer-section-link="SDKs" class="svelte-ytvx2v">SDKs</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/docs/sample-apps" data-test-site-footer-section-link="Sample apps" class="svelte-ytvx2v">Sample apps</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://www.issquareup.com/" data-test-site-footer-section-link="System status" class="svelte-ytvx2v">System status</a> </li></ul></div> <div class="dex-site-footer__section svelte-ytvx2v"><div class="dex-site-footer__section__heading__title svelte-ytvx2v" data-test-site-footer-section-title="Support">Support </div> <ul class="dex-site-footer__section__links svelte-ytvx2v"><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://developer.squareup.com/forums/" data-test-site-footer-section-link="Developer forums" class="svelte-ytvx2v">Developer forums</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/help/contact?panel=BF53A9C8EF68" data-test-site-footer-section-link="Contact support" class="svelte-ytvx2v">Contact support</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="/blog" data-test-site-footer-section-link="Developer blog" class="svelte-ytvx2v">Developer blog</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://discord.gg/squaredev" data-test-site-footer-section-link="Discord community" class="svelte-ytvx2v">Discord community</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://www.youtube.com/channel/UC1N2X6PEMGo2xjJY1Pm0vng" data-test-site-footer-section-link="YouTube" class="svelte-ytvx2v">YouTube</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://twitter.com/SquareDev" data-test-site-footer-section-link="X" class="svelte-ytvx2v">X</a> </li></ul></div> <div class="dex-site-footer__section svelte-ytvx2v"><div class="dex-site-footer__section__heading__title svelte-ytvx2v" data-test-site-footer-section-title="More">More </div> <ul class="dex-site-footer__section__links svelte-ytvx2v"><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com" data-test-site-footer-section-link="Square Home" class="svelte-ytvx2v">Square Home</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://developer.squareup.com" data-test-site-footer-section-link="Square Developer" class="svelte-ytvx2v">Square Developer</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/app-marketplace" data-test-site-footer-section-link="App Marketplace" class="svelte-ytvx2v">App Marketplace</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/partnerships" data-test-site-footer-section-link="Partner with Square" class="svelte-ytvx2v">Partner with Square</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/partnerships/solutions-partner-program" data-test-site-footer-section-link="Solutions Partner Program" class="svelte-ytvx2v">Solutions Partner Program</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/pricing" data-test-site-footer-section-link="Pricing" class="svelte-ytvx2v">Pricing</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/sales" data-test-site-footer-section-link="Sales" class="svelte-ytvx2v">Sales</a> </li></ul></div> <div class="dex-site-footer__square-container svelte-ytvx2v"><p class="dex-site-footer__square-text svelte-ytvx2v">漏 2025 Square, Inc. </p> <ul class="dex-site-footer__section__links svelte-ytvx2v"><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/legal/general/developers" data-test-site-footer-section-link="Developer terms of service" class="svelte-ytvx2v">Developer terms of service</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/legal/general/global-developer-integration-marketing-agreement" data-test-site-footer-section-link="Developer Integration and Marketing Agreement" class="svelte-ytvx2v">Developer Integration and Marketing Agreement</a> </li><li class="dex-site-footer__section__links__item svelte-ytvx2v"><a href="https://squareup.com/legal/general/privacy" data-test-site-footer-section-link="Privacy policy" class="svelte-ytvx2v">Privacy policy</a> </li> </ul></div></footer> </div></div></div></div></div></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"data":{"getFlags":{"data":{"addons_page_devs_console":false,"api_explorer_in_explorer_ui":false,"api_explorer_input_retention":true,"api_explorer_migration_enabled":true,"api_explorer_null_fields":true,"api_explorer_sdk_visibility":true,"api_explorer_share_link":true,"api_explorer_standalone_navigation":true,"api_keys_enabled":false,"api_logger_alpha":true,"api_logs_opt_in_enabled":false,"api_logs_to_explorer_share_link":true,"api_ref_rewrite_proxy_enabled":true,"api_version_migrator_alpha":false,"app_launch_beta":true,"app_launch_comment_history_revamp":true,"app_launch_video_submissions":true,"ccpa_enabled":true,"code_blocks_to_explorer_share_link":true,"dev_portal_app_marketplace_listings":true,"dev_portal_overview_page":false,"developer_data_feedback_param_validation":true,"developer_feedback_phase_one":true,"developer_onboarding":true,"developer_onboarding_questions":true,"developer_onboarding_variant":"V0_0","developer_rbac_permissions":true,"developer_recommendations":true,"devplat/api_explorer_in_explorer_ui":false,"devplat/api_explorer_standalone_navigation":true,"devplat/api_logger_alpha":true,"devplat/dev_portal_app_marketplace_listings":true,"devplat/fern_dotnet_examples":false,"devplat/fern_go_examples":true,"devplat/fern_java_examples":false,"devplat/fern_node_examples":true,"devplat/fern_php_examples":false,"devplat/fern_python_examples":false,"devplat/fern_ruby_examples":false,"devplat/firestorm_api_explorer":true,"devplat/firestorm_api_explorer_sdk_examples":true,"devplat/firestorm_connect_v1":true,"devplat/firestorm_docs_api_explorer_ga":true,"devplat/firestorm_docs_ga":true,"devplat/firestorm_docs_php_examples":false,"devplat/firestorm_static_lang_examples":true,"devplat/sandbox_seed_data_enabled":true,"devs_console_app_marketplace_reviews_page":true,"devs_console_app_reviews_page":false,"devs_console_app_submissions":false,"devs_console_app_subscription_pages":true,"devs_console_app_subscription_plan_management":true,"devs_console_apps_page":true,"devs_console_incomplete_features":false,"devs_console_locations_page":true,"devs_console_mpsdk_page":false,"devs_console_oauth_page":true,"devs_console_settings_pages":true,"devs_console_webhook_subscriptions":false,"dex/addons_page_devs_console":false,"dex/api_explorer_input_retention":true,"dex/api_explorer_null_fields":true,"dex/api_explorer_sdk_visibility":true,"dex/api_explorer_share_link":true,"dex/api_keys_enabled":false,"dex/api_logs_opt_in_enabled":false,"dex/api_logs_to_explorer_share_link":true,"dex/api_ref_rewrite_proxy_enabled":true,"dex/api_version_migrator_alpha":false,"dex/app_launch_beta":true,"dex/app_launch_comment_history_revamp":true,"dex/app_launch_video_submissions":true,"dex/ccpa_enabled":true,"dex/code_blocks_to_explorer_share_link":true,"dex/dev_portal_overview_page":false,"dex/developer_data_feedback_param_validation":true,"dex/developer_feedback_phase_one":true,"dex/developer_onboarding":true,"dex/developer_onboarding_questions":true,"dex/developer_onboarding_variant":"V0_0","dex/developer_rbac_permissions":true,"dex/developer_recommendations":true,"dex/devs_console_app_marketplace_reviews_page":true,"dex/devs_console_app_reviews_page":false,"dex/devs_console_app_submissions":false,"dex/devs_console_app_subscription_pages":true,"dex/devs_console_app_subscription_plan_management":true,"dex/devs_console_apps_page":true,"dex/devs_console_incomplete_features":false,"dex/devs_console_locations_page":true,"dex/devs_console_oauth_page":true,"dex/devs_console_settings_pages":true,"dex/doc_link_preview":false,"dex/docs_link_preview":false,"dex/explorer_to_logger_link":false,"dex/fetch_devs_content_connectv2":true,"dex/fetch_devs_content_files":true,"dex/fetch_devs_content_sparkplug":true,"dex/firestorm_docs_access_token_input_ux_changes":false,"dex/firestorm_docs_changelog":false,"dex/firestorm_docs_links_to_longform":true,"dex/firestorm_docs_multiple_examples":true,"dex/firestorm_docs_new_left_nav":true,"dex/firestorm_docs_sandbox_access_tokens":true,"dex/firestorm_docs_webhooks":true,"dex/global_nav_phase_one":true,"dex/global_search_frontend":true,"dex/graphql_explorer_alpha":true,"dex/graphql_explorer_production":true,"dex/heartbeat_monitor_enabled":true,"dex/ignition_nodejs_examples":true,"dex/ignition_php_examples":true,"dex/lfd_migration_enabled":true,"dex/markdown_link_preview":true,"dex/mobile_payments_sdk_docs_enabled":true,"dex/narrow_property_table":true,"dex/onetrust_enabled":true,"dex/payment_supported_countries":false,"dex/person_based_rbac":true,"dex/remarkability_feb_2022":false,"dex/remarkability_jul_2022":true,"dex/scenario_builder_mvp":false,"dex/smart_code_block_enabled":true,"dex/square_labs_allowed":false,"dex/use_split_users_endpoint":true,"dex/web_app_log_to_cdp":true,"dex/web_app_log_to_es2":true,"dex/web_payments_sdk_ga":true,"doc_link_preview":false,"docs_link_preview":false,"dpw/api_explorer_migration_enabled":true,"dpw/devs_console_mpsdk_page":false,"dpw/devs_console_webhook_subscriptions":false,"dpw/flagged_resubmission":false,"dpw/legacy_app_marketplace_partners":false,"explorer_to_logger_link":false,"fern_dotnet_examples":false,"fern_go_examples":true,"fern_java_examples":false,"fern_node_examples":true,"fern_php_examples":false,"fern_python_examples":false,"fern_ruby_examples":false,"fetch_devs_content_connectv2":true,"fetch_devs_content_files":true,"fetch_devs_content_sparkplug":true,"firestorm_api_explorer":true,"firestorm_api_explorer_sdk_examples":true,"firestorm_connect_v1":true,"firestorm_docs_access_token_input_ux_changes":false,"firestorm_docs_api_explorer_ga":true,"firestorm_docs_changelog":false,"firestorm_docs_ga":true,"firestorm_docs_links_to_longform":true,"firestorm_docs_multiple_examples":true,"firestorm_docs_new_left_nav":true,"firestorm_docs_php_examples":false,"firestorm_docs_sandbox_access_tokens":true,"firestorm_docs_webhooks":true,"firestorm_static_lang_examples":true,"flagged_resubmission":false,"global_nav_phase_one":true,"global_search_frontend":true,"graphql_explorer_alpha":true,"graphql_explorer_production":true,"heartbeat_monitor_enabled":true,"ignition_nodejs_examples":true,"ignition_php_examples":true,"legacy_app_marketplace_partners":false,"lfd_migration_enabled":true,"markdown_link_preview":true,"mobile_payments_sdk_docs_enabled":true,"narrow_property_table":true,"onetrust_enabled":true,"payment_supported_countries":false,"person_based_rbac":true,"remarkability_feb_2022":false,"remarkability_jul_2022":true,"sandbox_account_limit":"INT64_10","sandbox_seed_data_enabled":true,"sandcastle/sandbox_account_limit":"INT64_10","scenario_builder_mvp":false,"smart_code_block_enabled":true,"square_labs_allowed":false,"use_split_users_endpoint":true,"web_app_log_to_cdp":true,"web_app_log_to_es2":true,"web_payments_sdk_ga":true},"meta":{"headers":{},"status":200,"statusText":"OK"}},"doc":{"pageInView":{"page":{"type":"doc-page","id":"3JsUVg3ZPKSkVGjLlhuWCL","slug":"customers","searchSummary":"Use customer APIs to securely manage customer data, encourage repeat business, attract new customers, and analyze customer interactions.","heading":{"title":"Customer APIs","browserTitle":"Customer API: Securely Manage Customer Data","releaseStatus":"CAPABILITY"},"languagesSupported":["All"],"platforms":["All"],"leftNavId":"4URmYFehLwquxQBCQKBKSx","content":[{"type":"markdown","name":"customers markdown copy","markdown":"---\n{ \"pageType\": \"landing\", \"pageColorTheme\": \"pink\" }\n---\n{% toc disabled=true /%}\n{% banner capability=\"customers\" %}\n\nThe [Square Developer platform](homepage) provides customer APIs to build applications that help sellers grow their businesses through strong customer relationships. Use the customer APIs to securely manage customer data, analyze buying behavior, and integrate engagement features to increase repeat business and attract new customers.\n{% /banner %}\n\n## Square products\nSellers can access and manage customer features from a variety of Square products.\n\n{% tabset %}\n{% tab id=\"Customer Directory\" imageWidth=444 imageHeight=258 imageUrl=\"//images.ctfassets.net/1nw4q0oohfju/7alC3HJ4L6aZxdSnCwqYNl/d230ffe4b9f684466f9440c6de86cfbc/Customer_Directory.png\" %}\n{% card %}\nA free CRM software built into all Square payment tools where sellers can store information about their customers, analyze how they interact with their business, and actively engage with them.\n\nWith access to customer data like purchase history or loyalty status, sellers can understand their customers better and make smarter business decisions.\n\n{% card-link-out href=\"https://{{SQUARE_DOMAIN}}/point-of-sale/features/customer-directory\" %}Learn about Square Customer Directory{% /card-link-out %}\n{% /card %}\n{% /tab %}\n\n{% tab id=\"Square Loyalty\" imageWidth=420 imageHeight=220 imageUrl=\"//images.ctfassets.net/1nw4q0oohfju/6ZaJyp50YwtsiufbXStzTL/b73448bc6a9c628eb0c62f99c7520756/Square_Loyalty.png\" %}\n{% card %}\nA subscription-based loyalty program that rewards buyers for purchases and encourages repeat business. Sellers can choose whether customers earn points by visits, amount spent, or items purchased to help reach business goals.\n\nSquare Loyalty integrates directly with [Square Marketing](https://{{SQUARE_DOMAIN}}/marketing) so sellers can send engaging campaigns to keep customers informed and coming back.\n\n{% card-link-out href=\"https://{{SQUARE_DOMAIN}}/software/loyalty\" %}Learn about Square Loyalty{% /card-link-out %}\n{% /card %}\n{% /tab %}\n\n{% tab id=\"Square Marketing\" imageWidth=420 imageHeight=220 imageUrl=\"//images.ctfassets.net/1nw4q0oohfju/4hNf1ncLIPL7unQIqFJuqf/83fa29ef1bb89122a8ed1c14dfa790d5/Square-Marketing.png\" %}\n{% card %}\nProvides marketing tools and other resources to help sellers build stronger customer relationships, drive repeat business, and grow their businesses. \n\nSellers can create, send, and track email marketing campaigns in minutes to increase repeat business, as well as reach customers directly and easily with one-time and automated text message campaigns.\n\n{% card-link-out href=\"https://{{SQUARE_DOMAIN}}/marketing\" %}Learn about Square Marketing{% /card-link-out %}\n\n{% /card %}\n{% /tab %}\n\n{% tab id=\"Square Gift Cards\" imageWidth=420 imageHeight=220 imageUrl=\"//images.ctfassets.net/1nw4q0oohfju/7bU1lIZYSizRpzBJrhgjNO/6a0fee1396ef54ac08bd69d6bb5232b0/Square_Gift_Cards.png\" %}\n{% card %}\nEnables sellers to launch a gift card program to help attract new customers and boost sales. Square gift cards can be digital or physical, sold in person and online, and redeemed just like any other form of payment.\n\nCustomers can check their balance, reload their gift cards themselves, and send digital cards to friends to introduce them to the seller's business.\n\n{% card-link-out href=\"https://{{SQUARE_DOMAIN}}/gift-cards\" %}Learn about Square Gift Cards{% /card-link-out %}\n\n{% /card %}\n{% /tab %}\n\n{% /tabset %}\n\n## Build with customer APIs\nUse the following APIs to integrate customer management and engagement features in your application.\n\n{% card-layout type=\"grid\" %}\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/2n9wYQoxTE2HMbiRIz0dV3/2bd828e6ee20dadb22bee170b372649b/handshake-pink.svg\" href=\"customers-api/what-it-does\" %}\n **Customers API**\n\n Manage customer profiles and group membership, search the directory, and sync records with CRM systems.\n {% /card %}\n\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/y2tdQtshsIVHX7LzYkJmA/9329b9a538548058e0e1a2e07e5a45db/human-plus-pink.svg\" href=\"customer-custom-attributes-api/overview\" %}\n **Customer Custom Attributes API**\n\n Define custom properties for customer profiles to unlock customization scenarios.\n {% /card %}\n\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/1JfMCY2zHULCJ6GRtZPdag/cfdf428ef30f29b3b392031534173811/folder-human-pink.svg\" href=\"customer-groups-api/what-it-does\" %}\n **Customer Groups API**\n\n Create groups to enable scoped promotions at scale and actions based on group membership.\n {% /card %}\n\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/2z1cjORz0gn6LHtlHxMnWy/d8a98bb6207c2797dd315fab8f600551/chart-bar.svg\" href=\"customer-segments-api/what-it-does\" %}\n **Customer Segments API**\n\n Get basic details about segments that filter customers by buying behavior and other traits.\n {% /card %}\n\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/4CsZC276gjnS9bH1n9h38R/162873614dd6aa84367bbbb515efd014/star-pink.svg\" href=\"loyalty-api/overview\" %}\n **Loyalty API**\n\n Create accounts and promotions and let buyers earn points and redeem reward discounts.\n {% /card %}\n\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/70ZFClu9PFZ4DZ2H4eTlCr/d83c4efe2e9bbf5b1223b9cd98283d57/gift-card-pink.svg\" href=\"gift-cards/using-gift-cards-api\" %}\n **Gift Cards API**\n\n Create and activate gift cards, reload card balances, and track gift card activities.\n {% /card %}\n{% /card-layout %}\n\n## Customer sample applications\nGet up and running quickly with Square customer APIs and see the APIs in action.\n\n{% card-layout type=\"grid\" disableCardLink=true %}\n {% card %}\n **Gift Cards API Sample**\n\n Shows how to sell and reload gift cards, link customers, view activity history, and generate barcodes.\n\n {% icon-container\niconPath=\"//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg\" %}\n**[Node.js](https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_gift-cards)**\n {% /icon-container %}\n\n {% /card %}\n\n {% card %}\n **Order-Ahead Sample**\n\n Lets buyers place online orders, choose delivery options, earn loyalty points, and pay for an order.\n\n {% icon-container iconPath=\"//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg\" %}\n **[Node.js](https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_orders-payments)**\n {% /icon-container %}\n {% /card %}\n\n {% card %}\n **Bookings API Sample**\n\n Checks availability and books an appointment for a customer with a team member.\n\n {% icon-container iconPath=\"//images.ctfassets.net/1nw4q0oohfju/1F1K7KlzGNwQHdAEdee1YI/ad3cdaa7103359c99131a793e401c1fd/nodejs-lp.svg\" %}\n **[Node.js](https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_bookings)**\n {% /icon-container %}\n {% /card %}\n\n{% /card-layout %}\n\n## Customer guides\nLearn about commonly used features and tasks you can do with customer APIs. \n\n{% carousel %}\n {% carousel-card title=\"Manage Customer Profiles\" href=\"customers-api/use-the-api/keep-records\" %}Create, update, and delete customer profiles in a seller's Customer Directory.{% /carousel-card %}\n {% carousel-card title=\"Manage Loyalty Rewards\" href=\"loyalty-api/loyalty-rewards\" %}Create and manage loyalty rewards that allow buyers to redeem points for discounts.{% /carousel-card %}\n {% carousel-card title=\"Sell Square Gift Cards\" href=\"gift-cards/sell-gift-cards\" %}Create and activate a gift card that can be used at any of the seller's locations.{% /carousel-card %}\n {% carousel-card title=\"Search for Customer Profiles\" href=\"customers-api/use-the-api/search-customers\" %}Search the Customer Directory by phone number, email address, and other attributes.{% /carousel-card %}\n{% /carousel %}\n\n## Extend customers with other API groups\nCombine customer features with other Square APIs to build engagements across all areas of a seller's business and see buyer trends.\n\n{% card-layout type=\"grid\" disableCardLink=true %}\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/6F8p3hDRca8fhlPkqJHBnQ/1fa527dd360f527d904c55e949c67a91/paymentsxcustomers.svg\" iconWidth=149 iconHeight=96 iconBorder=false href=\"payments-overview\" %}\n **Payments 脳 Customers**\n\n Link customers to payment flows, subscriptions, and invoices and take gift card payments with automatic redemption.\n\n {% card-link-out %}Payment APIs{% /card-link-out %}\n {% /card %}\n\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/6phgVDg7Gs3CkWFok2kAm8/345988546b5e8cce5917a6411fa14af0/commercexcustomers.svg\" iconWidth=149 iconHeight=96 iconBorder=false href=\"commerce\" %}\n **Commerce 脳 Customers**\n\n Integrate with orders, a catalog, and bookings and use simplified flows for loyalty and gift cards.\n\n {% card-link-out %}Commerce APIs{% /card-link-out %}\n {% /card %}\n\n {% card iconPath=\"//images.ctfassets.net/1nw4q0oohfju/5hLSU3wWta0bTzEdvj997a/99ec6c64ce38471b415c9ae2cf89371d/staffxcustomers.svg\" iconWidth=149 iconHeight=96 iconBorder=false href=\"staff\" %}\n **Staff 脳 Customers**\n\n Connect regular customers with favorite team members through payments and bookings.\n\n {% card-link-out %}Staff APIs{% /card-link-out %}\n {% /card %}\n{% /card-layout %}","programmingLanguage":"All","platform":"All"}]},"requirementsDomain":null},"navSet":{"value":{"items":[{"type":"link","url":"/","title":"Docs Home"},{"type":"divider","style":"divider"},{"id":"iO7IcPwigJctqIkoJ11Zo","type":"subcategory","items":[{"id":"7dlzvOUwboNqjIqujGxzcq","type":"subcategory","items":[{"type":"link","url":"/get-started/create-account-and-application","title":"Create an Account and App"},{"type":"link","url":"/get-started/make-api-request","title":"Make your First API Call"},{"type":"link","url":"/get-started/view-log","title":"View the API Logs"},{"type":"link","url":"/get-started/verify-transaction-in-seller-dashboard","title":"Verify the Payment"},{"type":"link","url":"/get-started/what-next","title":"What's Next"}],"title":"Get Started","url":"/square-get-started"},{"type":"divider","style":"divider"},{"type":"link","url":"/development-essentials","title":"Overview"},{"id":"2bnJ76IVdWdlJkBxvg7SmH","type":"subcategory","items":[{"type":"link","url":"/build-basics/versioning-overview","title":"Versioning"},{"type":"link","url":"/build-basics/access-tokens","title":"Access Tokens"},{"type":"link","url":"/build-basics/frontend-backend-development","title":"Frontend and Backend Development"},{"id":"4TMGdBKMRZhCtNaE99difL","type":"subcategory","items":[{"type":"link","url":"/build-basics/general-considerations/tls-and-https","title":"TLS and HTTPS"},{"type":"link","url":"/build-basics/general-considerations/using-rest-api","title":"Using the REST API"},{"type":"link","url":"/build-basics/general-considerations/handling-errors","title":"Handling Errors"},{"type":"link","url":"/build-basics/general-considerations/collecting-information","title":"Collecting Information"},{"type":"link","url":"/build-basics/general-considerations/language-preferences","title":"Language Preferences"}],"title":"General Development Concepts","url":"/build-basics/general-considerations"},{"id":"3aMdMffYnkZVVVgdISQxCp","type":"subcategory","items":[{"type":"link","url":"/build-basics/common-data-types/working-with-dates","title":"Working with Dates"},{"type":"link","url":"/build-basics/common-data-types/working-with-monetary-amounts","title":" Working with Monetary Amounts"},{"type":"link","url":"/build-basics/common-data-types/working-with-addresses","title":"Working with Addresses"}],"title":"Common Data Types","url":"/build-basics/common-data-types"},{"id":"3RImgYl86M2FgJQKHeKyoX","type":"subcategory","items":[{"type":"link","url":"/devtools/customattributes/overview","title":"Custom Attributes"},{"type":"link","url":"/build-basics/common-api-patterns/idempotency","title":"Idempotency"},{"type":"link","url":"/build-basics/common-api-patterns/pagination","title":"Pagination"},{"type":"link","url":"/build-basics/common-api-patterns/optimistic-concurrency","title":"Optimistic Concurrency"},{"type":"link","url":"/build-basics/clearing-fields","title":"Clear Object Fields"}],"title":"Common Square API Patterns","url":"/build-basics/common-api-patterns"},{"type":"link","url":"/ecommerce-api","title":"Square eCommerce APIs"},{"type":"link","url":"/build-basics/api-lifecycle","title":"Square API Lifecycle"}],"title":"Build Basics","url":"/buildbasics"},{"id":"3xPiA4blL9jPuuayGJ6MTW","type":"subcategory","items":[{"type":"link","url":"/devtools/developer-dashboard","title":"Developer Console"},{"type":"link","url":"/devtools/seller-dashboard","title":"Square Dashboard"},{"id":"3KRB4IB9BlZtJ6B2m6vUfS","type":"subcategory","items":[{"type":"link","url":"/devtools/sandbox/testing","title":"Test in Sandbox"},{"type":"link","url":"/devtools/sandbox/payments","title":"Sandbox Payments"},{"type":"link","url":"/devtools/sandbox/seed-data","title":"Sandbox Seeding Data"}],"title":"Sandbox","url":"/devtools/sandbox/overview"},{"type":"link","url":"/devtools/api-explorer","title":"API Explorer"},{"type":"link","url":"/devtools/api-logs","title":"API Logs"},{"type":"link","url":"/devtools/webhook-logs","title":"Webhook Event Logs"},{"id":"gjri5F4fH2T3zkF44a67X","type":"subcategory","items":[{"type":"link","url":"/webhooks/step1createurl","title":"Create a Notification URL"},{"type":"link","url":"/webhooks/step2subscribe","title":"Subscribe to Event Notifications"},{"type":"link","url":"/webhooks/step3validate","title":"Verify and Validate an Event Notification"},{"type":"link","url":"/webhooks/step4manage","title":"Manage Operations"},{"type":"link","url":"/webhooks/movetoprod","title":"Move Event Notifications to Production"},{"type":"link","url":"/webhooks/v2webhook-events-tech-ref","title":"Webhook Events Reference"},{"type":"link","url":"/webhooks/troubleshooting","title":"Troubleshooting"}],"title":"Webhooks","url":"/webhooks/overview"},{"type":"link","url":"/devtools/developer-permissions","title":"Build a Developer Team"},{"type":"link","url":"/auth","title":"Authentication"},{"type":"link","url":"/devtools/postman","title":"Postman"}],"title":"Developer Tools","url":"/devtools/overview"},{"id":"3Dla3ISAkrXINrZrVMau3d","type":"subcategory","items":[{"id":"2Ca4WvgGRCnQW4KBXsLDjR","type":"subcategory","items":[{"type":"link","url":"/sdks/java/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/java/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/java/using-java-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/java/common-square-api-patterns","title":"Common API Patterns"}],"title":"Java","url":"/sdks/java"},{"id":"6ioIsulmzIRS1Fp5LbpySx","type":"subcategory","items":[{"type":"link","url":"/sdks/dotnet/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/dotnet/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/dotnet/using-dot-net-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/dotnet/common-square-api-patterns","title":"Common API Patterns"}],"title":".NET","url":"/sdks/dotnet"},{"id":"TtR5ma1jNu33j5Up3QRZ7","type":"subcategory","items":[{"type":"link","url":"/sdks/nodejs/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/nodejs/common-square-api-patterns","title":"Common API Patterns"},{"type":"link","url":"/sdks/nodejs/migration","title":"Migration Guide"}],"title":"Node.js","url":"/sdks/nodejs"},{"id":"3hWuvXuREAS464rBzFn5S6","type":"subcategory","items":[{"type":"link","url":"/sdks/php/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/php/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/php/using-php-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/php/common-square-api-patterns","title":"Common API Patterns"}],"title":"PHP","url":"/sdks/php"},{"id":"6wVrPqjTomk2Pg7Y2aPTPX","type":"subcategory","items":[{"type":"link","url":"/sdks/python/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/python/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/python/using-python-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/python/common-square-api-patterns","title":"Common API Patterns"}],"title":"Python","url":"/sdks/python"},{"id":"1tWDddcaCZLVqVBGIxvs4A","type":"subcategory","items":[{"type":"link","url":"/sdks/ruby/quick-start","title":"Quickstart"},{"type":"link","url":"/sdks/ruby/setup-project","title":"Project Setup"},{"type":"link","url":"/sdks/ruby/using-ruby-sdk","title":"Using the SDK"},{"type":"link","url":"/sdks/ruby/common-square-api-patterns","title":"Common API Patterns"}],"title":"Ruby","url":"/sdks/ruby"},{"id":"3geJJhUlXHHQQDcUGty5BW","type":"subcategory","items":[{"type":"link","url":"/sdks/go/quick-start","title":"Quickstart"}],"title":"Go","url":"/sdks/go"}],"title":"Square SDKs","url":"/sdks"},{"type":"link","url":"/sample-apps","title":"Sample Applications"},{"type":"divider","style":"divider"},{"id":"31uVZVus1mPqbgRgRBWk2b","type":"subcategory","items":[{"type":"link","url":"/graphql/basics","title":"GraphQL Basics"},{"type":"link","url":"/graphql/build-your-first-query","title":"Build your First Query"},{"type":"link","url":"/devtools/graphqlexplorer","title":"GraphQL Explorer"},{"type":"link","url":"/graphql/query-examples","title":"Query Examples"}],"title":"GraphQL","url":"/devtools/graphql"},{"type":"divider","style":"divider"},{"id":"1xR5tTBo3FKTtqQB9F8d6J","type":"subcategory","items":[{"type":"link","url":"/oauth-api/create-urls-for-square-authorization","title":"Create Redirect URL and Authorization Page URL"},{"type":"link","url":"/oauth-api/receive-and-manage-tokens","title":"Receive Authorization and Manage OAuth Tokens"},{"type":"link","url":"/oauth-api/refresh-revoke-limit-scope","title":"Refresh and Revoke OAuth Tokens"},{"type":"link","url":"/oauth-api/token-introspection","title":"Token Introspection"},{"type":"link","url":"/oauth-api/best-practices","title":"OAuth Best Practices"},{"type":"link","url":"/oauth-api/walkthrough","title":"OAuth Walkthrough"},{"type":"link","url":"/oauth-api/migrate-to-square-oauth-flow","title":"Migrate to the Square API OAuth Flow"},{"type":"link","url":"/oauth-api/movetoprod","title":"Move OAuth to Production"},{"type":"link","url":"/oauth-api/square-permissions","title":"Permissions Reference"}],"title":"OAuth","url":"/oauth-api/overview"},{"type":"link","url":"/webhooks/webhook-subscriptions-api","title":"Webhook Subscriptions"},{"type":"link","url":"/events-api/overview","title":"Events"},{"type":"divider","style":"divider"},{"id":"2b6GKzXmebfh3NFImkw69V","type":"subcategory","items":[{"type":"link","url":"/migrate-from-v1/current-status","title":"Deprecated Items"},{"id":"2S2I7wKsntsXiMbpEYl1vv","type":"subcategory","items":[{"type":"link","url":"/migrate-from-v1/guides/v1-payments","title":"v1 Payments API"},{"type":"link","url":"/migrate-from-v1/guides/v1-refunds","title":"v1 Refunds API"},{"type":"link","url":"/payments-api/migrate-from-transactions-api","title":"Square Transactions API"},{"type":"link","url":"/labor-api/migrate-to-teams","title":"Migrate Employees to Team Members"},{"type":"link","url":"/migrate-from-v1/guides/v1-checkout","title":"Migrate from CreateCheckout to CreatePaymentLink"}],"title":"API Migration Guides"}],"title":"Migrate from Deprecated APIs","url":"/migrate-from-v1"},{"id":"2FbyzmNmotvJlFa0lkrvGa","type":"subcategory","items":[{"type":"link","url":"/international-development/oauth-testing","title":"OAuth and Testing"},{"type":"link","url":"/international-development/payments","title":"International Payments"},{"type":"link","url":"/international-development/regional-differences","title":"Regional Differences for International Development"},{"type":"link","url":"/international-development/japan-invoice-system","title":"Compliance with Japan's Tax Invoice System"}],"title":"International Development","url":"/international-development"}],"title":"Dev Essentials","url":"/development-essentials"},{"type":"divider","style":"divider"},{"id":"1JxXf5dweJNagXLkQOFGsh","type":"subcategory","items":[{"type":"link","url":"/payments-overview","title":"Overview"},{"id":"7zfhvbp4AghuyT3BkoJd1v","type":"subcategory","items":[{"type":"link","url":"/payments/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/payments/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/payments/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/payments/scenarios"},{"id":"uUZ9NoDit8f9tVTf5zSRm","type":"subcategory","items":[{"id":"1gxFZ2zjIW9IxVIOVrlHsi","type":"subcategory","items":[{"id":"cX9mbMbYzJRiexfbw1HuZ","type":"subcategory","items":[{"type":"link","url":"/payments-api/take-payments/card-payments/delayed-capture","title":"Delayed Capture"},{"type":"link","url":"/payments-api/take-payments/card-payments/partial-payments-with-gift-cards","title":"Partial Payments"},{"type":"link","url":"/payments-api/take-payments/card-payments/statement-descriptions","title":"Statement Descriptions"}],"title":"Card Payments","url":"/payments-api/take-payments/card-payments"},{"type":"link","url":"/payments-api/take-payments/ach-payments","title":"ACH Bank Transfer Payment"},{"type":"link","url":"/payments-api/take-payments/afterpay-payments","title":"Afterpay and Clearpay Payments"},{"type":"link","url":"/payments-api/take-payments/cash-app-payments","title":"Cash App Payments"},{"type":"link","url":"/payments-api/take-payments/cash-payments","title":"Cash Payments"},{"type":"link","url":"/payments-api/take-payments/external-payments","title":"External Payments"},{"type":"link","url":"/payments-api/take-payments/house-accounts","title":"House Accounts"}],"title":"Take Payments","url":"/payments-api/take-payments"},{"type":"link","url":"/payments-api/take-payments-and-collect-fees","title":"Collect Application Fees"},{"type":"link","url":"/payments-api/update-payments","title":"Update Payment and Tip Amounts"},{"type":"link","url":"/payments-api/retrieve-payments","title":"Retrieve Payments"},{"type":"link","url":"/payments-api/error-codes","title":"Troubleshoot"},{"type":"link","url":"/payments-api/webhooks","title":"Webhooks"}],"title":"Payments","url":"/payments-refunds"},{"id":"2zvmrqXp2ajTw6sZprzRpu","type":"subcategory","items":[{"type":"link","url":"/payments-api/refund-payments","title":"Refund Payments"},{"type":"link","url":"/payments-api/collect-fees/payment-with-app-fee-refund","title":"Refund a Payment with an App Fee"},{"type":"link","url":"/refunds-api/retrieve-refunds","title":"Retrieve Refunds"},{"type":"link","url":"/refunds-api/unlinked-refunds","title":"Process an Unlinked Refund"},{"type":"link","url":"/refunds-api/webhooks","title":"Webhooks"}],"title":"Refunds","url":"/refunds-api/overview"},{"id":"zsWHyi2OOINzGoMk3KheJ","type":"subcategory","items":[{"type":"link","url":"/disputes-api/process-disputes","title":"Process Disputes"},{"type":"link","url":"/disputes-api/sandbox-testing","title":"Test in the Sandbox"}],"title":"Disputes","url":"/disputes-api/overview"},{"type":"divider","style":"divider"},{"id":"3QI4Ij83kOJO4XY5vg44ec","type":"subcategory","items":[{"id":"4qST1Mhcut4CEO49Ymx2wJ","type":"subcategory","items":[{"type":"link","url":"/terminal-api/quickstart","title":"Quickstart"},{"type":"link","url":"/terminal-api/square-terminal-payments","title":"Take Payments"},{"type":"link","url":"/terminal-api/pos-integration","title":"POS App Pairing with Square Terminal"},{"type":"link","url":"/terminal-api/dismiss-checkouts-and-refunds","title":"Dismiss Terminal Checkouts and Refunds"},{"type":"link","url":"/terminal-api/terminal-device-monitoring","title":"Monitor Square Terminals"},{"type":"link","url":"/terminal-api/advanced-features","title":"Manage Terminal Actions"},{"type":"link","url":"/terminal-api/advanced-features/save-card-on-file","title":"Save Card on File"},{"type":"link","url":"/terminal-api/advanced-features/check-device-information","title":"Check Device Information"},{"type":"link","url":"/terminal-api/advanced-features/issue-receipts","title":"Print or Issue Receipts"},{"type":"link","url":"/terminal-api/advanced-features/customize-idle-screen","title":"Customize the Idle Screen"},{"id":"5csDnJcAAfXw1PIO507K5i","type":"subcategory","items":[{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/confirmation","title":"Confirmation Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/signature","title":"Signature Capture Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/data-collection","title":"Data Collection Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/menu-select","title":"Menu Selection List Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/qr-code-display","title":"QR Code Screen"},{"type":"link","url":"/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions","title":"Link and Dismiss Actions"}],"title":"Custom Screen Workflows","url":"/terminal-api/advanced-features/custom-workflows"},{"id":"1diR890qlxltZJ0tUr6fPB","type":"subcategory","items":[{"type":"link","url":"/terminal-api/square-terminal-refunds","title":"Refund Interac Payments"},{"type":"link","url":"/terminal-api/e-money-payments","title":"Take E-Money Payments"},{"type":"link","url":"/terminal-api/international-payment-methods/paypay-qr-code-payments","title":"Take QR Code Payments for Digital Wallets"}],"title":"International Payment Methods","url":"/terminal-api/international-payment-methods"}],"title":"Terminal API","url":"/terminal-api/overview"},{"id":"4sRkVAYqVuVcsx5Xht8EIO","type":"subcategory","items":[{"id":"V2EiCWkS7R7XRjihKoGRJ","type":"subcategory","items":[{"type":"link","url":"/mobile-payments-sdk/android/configure-authorize","title":"Authorize the Mobile Payments SDK"},{"type":"link","url":"/mobile-payments-sdk/android/pair-manage-readers","title":"Pair and Manage Card Readers"},{"type":"link","url":"/mobile-payments-sdk/android/take-payments","title":"Take a Payment"},{"type":"link","url":"/mobile-payments-sdk/android/offline-payments","title":"Offline Payments"},{"type":"link","url":"/mobile-payments-sdk/android/handling-errors","title":"Handling Errors"}],"title":"Build on Android","url":"/mobile-payments-sdk/android"},{"id":"184IwlKxX3dToiJCIgybi7","type":"subcategory","items":[{"type":"link","url":"/mobile-payments-sdk/ios/configure-authorize","title":"Authorize the Mobile Payments SDK"},{"type":"link","url":"/mobile-payments-sdk/ios/pair-manage-readers","title":"Pair and Manage Card Readers"},{"type":"link","url":"/mobile-payments-sdk/ios/take-payments","title":"Take a Payment"},{"type":"link","url":"/mobile-payments-sdk/ios/offline-payments","title":"Offline Payments"},{"type":"link","url":"/mobile-payments-sdk/ios/square-stand","title":"Configure for Square Stand or Square Kiosk"},{"type":"link","url":"/mobile-payments-sdk/ios/handling-errors","title":"Handling Errors"}],"title":"Build on iOS","url":"/mobile-payments-sdk/ios"},{"type":"link","url":"/mobile-payments-sdk/migrate","title":"Migrate from Reader SDK"},{"type":"link","url":"/mobile-payments-sdk/react-native","title":"React Native Plugin"}],"title":"Mobile Payments SDK","url":"/mobile-payments-sdk"},{"id":"41VWCwHuOVzHNHKVQOT41","type":"subcategory","items":[{"type":"link","url":"/mobile-payments-sdk/migrate","title":"Migrate to Mobile Payments SDK"},{"id":"4xNhvuBpEO78hn0xLFBiJp","type":"subcategory","items":[{"type":"link","url":"/reader-sdk/quick-start/step-1","title":"Get Credentials"},{"type":"link","url":"/reader-sdk/quick-start/step-2","title":"Configure the Sample Application"},{"type":"link","url":"/reader-sdk/quick-start/step-3","title":"Take a Cash Payment"},{"type":"link","url":"/reader-sdk/quick-start/step-4","title":"Customize the Checkout Amount"},{"type":"link","url":"/reader-sdk/quick-start/step-5","title":"Take a Credit Card Payment"}],"title":"Quickstart","url":"/reader-sdk/quick-start/start"},{"type":"link","url":"/reader-sdk/how-it-works","title":"How It Works"},{"type":"link","url":"/reader-sdk/build-on-android","title":"Build on Android"},{"type":"link","url":"/reader-sdk/build-on-ios","title":"Build on iOS"},{"type":"link","url":"/reader-sdk/cookbook/contactless-reader","title":"Connect a Contactless Reader"},{"type":"link","url":"/reader-sdk/cookbook/charge-cards-on-file","title":"Charge a Card on File"},{"type":"link","url":"/reader-sdk/cookbook/save-cards-on-file","title":"Save a Card on File"},{"type":"link","url":"/reader-sdk/cookbook/square-stand","title":"Configure on iOS for Square Stand"},{"type":"link","url":"/reader-sdk/cookbook/deauthorize-reader-sdk","title":"Deauthorize Reader SDK"},{"type":"link","url":"/reader-sdk/cookbook/capture-a-transaction","title":"Capture a Transaction"},{"type":"link","url":"/reader-sdk/cookbook/delay-capture-of-payment","title":"Delay the Capture of Payments"},{"type":"link","url":"/reader-sdk/cookbook/configure-apk-splits","title":"Configure APK Splits"},{"type":"link","url":"/reader-sdk/upgrade-reader-sdk","title":"Update to New Reader SDK Version"},{"type":"link","url":"/reader-sdk/flutter","title":"Flutter Plugin"},{"type":"link","url":"/reader-sdk/react-native","title":"React Native Plugin"}],"title":"Reader SDK","url":"/reader-sdk/what-it-does"},{"id":"3afip77TiGS5ECyUYIRM96","type":"subcategory","items":[{"type":"link","url":"/pos-api/how-it-works","title":"How It Works"},{"type":"link","url":"/pos-api/build-on-android","title":"Build on Android"},{"type":"link","url":"/pos-api/build-on-ios","title":"Build on iOS"},{"type":"link","url":"/pos-api/build-mobile-web","title":"Build on Mobile Web"},{"type":"link","url":"/pos-api/cookbook/find-your-android-fingerprint","title":"Find Your Android Fingerprint"},{"type":"link","url":"/pos-api/cookbook/offline-mode","title":"Use the API in Offline Mode"},{"type":"link","url":"/pos-api/cookbook/alert-dialog-helper","title":"Add an Alert Dialog Helper Class"},{"type":"link","url":"/pos-api/cookbook/electronic-payments","title":"Accept E-Money Payments"},{"type":"link","url":"/pos-api/qr-code-payments-paypay","title":"Accept PayPay Payments"},{"type":"link","url":"/pos-api/web-technical-reference","title":"Mobile Web Technical Reference"},{"type":"link","url":"/pos-api/payments-integration","title":"Payments API Integration"}],"title":"Point of Sale API","url":"/pos-api/what-it-does"}],"title":"Take Payments on Hardware","url":"/in-person-payment-options"},{"id":"6sXAr41iJBMDHea2l3Z8gv","type":"subcategory","items":[{"id":"7jyjtk6YX9Vvjr6IB3nf2J","type":"subcategory","items":[{"id":"50fRf1DljbdST7WDPNFEwv","type":"subcategory","items":[{"type":"link","url":"/web-payments/quickstart/clone-quickstart-project","title":"Clone the Quickstart Project Template"},{"type":"link","url":"/web-payments/quickstart/add-sdk-to-web-client","title":"Add the SDK to the Web Client"},{"type":"link","url":"/web-payments/quickstart/verify-the-payment","title":"Verify the Payment"},{"type":"link","url":"/web-payments/quickstart/add-sca","title":"Add Strong Customer Authentication"},{"type":"link","url":"/web-payments/quickstart/deploy-app","title":"Deploy the Application"}],"title":"Quickstart","url":"/web-payments/quickstart"},{"type":"link","url":"/web-payments/take-card-payment","title":"Take a Card Payment"},{"id":"76vVgo6CnCmx5Xt8tJJnS8","type":"subcategory","items":[{"type":"link","url":"/web-payments/apple-pay","title":"Apple Pay"},{"type":"link","url":"/web-payments/google-pay","title":"Google Pay"},{"type":"link","url":"/web-payments/payment-requests","title":"Digital Wallet Payment Requests"}],"title":"Integrate Digital Wallets","url":"/web-payments/digital-wallets"},{"type":"link","url":"/web-payments/add-ach","title":"ACH Bank Transfer"},{"type":"link","url":"/web-payments/add-afterpay","title":"Afterpay"},{"type":"link","url":"/web-payments/add-cash-app-pay","title":"Cash App Pay"},{"id":"UmgjQ7AynheCEMWohcGmp","type":"subcategory","items":[{"type":"link","url":"/web-payments/gift-card","title":"Take a Gift Card Payment"},{"type":"link","url":"/web-payments/gift-card-walkthrough","title":"Take Partial Payments"}],"title":"Square Gift Card Payments","url":"/web-payments/gift-cards-intro"},{"type":"link","url":"/web-payments/customize-styles","title":"Customize the Card Entry Form"},{"type":"link","url":"/web-payments/sca","title":"Add SCA to a Card Payment"},{"type":"link","url":"/web-payments/sca-add-card","title":"Store a Card on File"},{"type":"link","url":"/web-payments/sca-charge-card-on-file","title":"Charge a Card on File"},{"type":"link","url":"/web-payments/sca-charge-and-store-card-on-file","title":"Charge and Store a Card on File"}],"title":"Web Payments SDK","url":"/web-payments/overview"},{"id":"3kx6yG9fmBAdJZbbO6F1yD","type":"subcategory","items":[{"id":"61aUeKzNEGAElKXXrUTg3x","type":"subcategory","items":[{"type":"link","url":"/in-app-payments-sdk/quick-start/generate-token","title":"Set up the Client"},{"type":"link","url":"/in-app-payments-sdk/quick-start/deploy-server-backend","title":"Deploy the Server"}],"title":"Quickstart","url":"/in-app-payments-sdk/quick-start"},{"type":"link","url":"/in-app-payments-sdk/installation","title":"Install the SDK"},{"type":"link","url":"/in-app-payments-sdk/build-on-android","title":"Build on Android"},{"type":"link","url":"/in-app-payments-sdk/build-on-ios","title":"Build on iOS"},{"id":"1YvixWOltemNhXC61aCNfc","type":"subcategory","items":[{"type":"link","url":"/in-app-payments-sdk/add-digital-wallets/google-pay","title":"Google Pay"},{"type":"link","url":"/in-app-payments-sdk/add-digital-wallets/apple-pay","title":"Apple Pay"},{"type":"link","url":"/in-app-payments-sdk/add-digital-wallets/src/android","title":"Enable SRC for Android"},{"type":"link","url":"/in-app-payments-sdk/add-digital-wallets/src/ios","title":"Enable SRC for iOS"}],"title":"Integrate Digital Wallets","url":"/in-app-payments-sdk/add-digital-wallets"},{"type":"link","url":"/in-app-payments/localize-ios","title":"Localize an Application "},{"type":"link","url":"/in-app-payments-sdk/cookbook/giftcards","title":"Gift Card Payments"},{"type":"link","url":"/in-app-payments-sdk/flutter","title":"Flutter Plugin"},{"type":"link","url":"/in-app-payments-sdk/react-native","title":"React Native Plugin"},{"type":"link","url":"/in-app-payments-sdk/cookbook/customize-payment-form","title":"Customize the Payment Entry Form"},{"type":"link","url":"/in-app-payments-sdk/cookbook/connect-to-a-backend-service","title":"Connect to a Backend Service"},{"type":"link","url":"/in-app-payments-sdk/cookbook/disable-postal-code","title":"Remove the Postal Code Requirement"},{"type":"link","url":"/in-app-payments-sdk/troubleshooting","title":"Troubleshoot"},{"type":"link","url":"/in-app-payments-sdk/how-it-works","title":"How It Works"},{"id":"6CxT0SjYvqtIoHogrU592e","type":"subcategory","items":[{"type":"link","url":"/in-app-payments-sdk/verify-buyer","title":"Verify a Buyer"}],"title":"Strong Customer Authentication","url":"/sca-overview-iap"}],"title":"In-App Payments SDK","url":"/in-app-payments-sdk/what-it-does"},{"id":"V4hkw0bOYUpdBadmYBHr0","type":"subcategory","items":[{"type":"link","url":"/checkout-api/quick-pay-checkout","title":"Quick Pay Checkout"},{"type":"link","url":"/checkout-api/square-order-checkout","title":"Square Order Checkout"},{"type":"link","url":"/checkout-api/subscription-plan-checkout","title":"Subscription Plan Checkout"},{"type":"link","url":"/checkout-api/checkout-settings","title":"Checkout Settings"},{"type":"link","url":"/checkout-api/optional-checkout-configurations","title":"Checkout Configurations"},{"type":"link","url":"/checkout-api/manage-checkout","title":"Manage Checkout"},{"type":"link","url":"/checkout-api/guidelines-and-limitations","title":"Guidelines and Limitations"}],"title":"Checkout API","url":"/checkout-api"},{"id":"48IHue04VlAsOncIA5GupV","type":"subcategory","items":[{"type":"link","url":"/subscriptions-api/plans-and-variations","title":"Subscription Plans and Variations"},{"type":"link","url":"/subscriptions-api/manage-subscriptions","title":"Manage Subscriptions"},{"type":"link","url":"/subscriptions-api/actions-events","title":"Subscription Actions and Events"},{"type":"link","url":"/subscriptions-api/pause-resume-cancel-subscriptions","title":"Pause, Resume, or Cancel Subscriptions"},{"type":"link","url":"/subscriptions-api/subscription-billing","title":"Subscription Billing and Invoices"},{"type":"link","url":"/subscriptions-api/swap-plan-variations","title":"Swap Subscription Plan Variations"}],"title":"Subscriptions API","url":"/subscriptions/overview"},{"id":"56mq1PzSktrD9m24himiW5","type":"subcategory","items":[{"type":"link","url":"/invoices-api/create-publish-invoices","title":"Create and Publish Invoices"},{"type":"link","url":"/invoices-api/retrieve-list-search-invoices","title":"Retrieve, List, or Search Invoices"},{"type":"link","url":"/invoices-api/attachments","title":"Create or Delete Invoice Attachments"},{"type":"link","url":"/invoices-api/update-invoices","title":"Update Invoices"},{"type":"link","url":"/invoices-api/cancel-delete-invoices","title":"Cancel or Delete Invoices"},{"type":"link","url":"/invoices-api/pay-refund-invoices","title":"Pay or Refund Invoices"},{"type":"link","url":"/invoices-api/walkthrough","title":"Walkthrough: Create and Publish Invoices"}],"title":"Invoices API","url":"/invoices-api/overview"}],"title":"Take Payments Online","url":"/online-payment-options"},{"type":"divider","style":"divider"},{"id":"3crTgQawiMx30ZW42kX5w8","type":"subcategory","items":[{"type":"link","url":"/cards-api/manage-cards","title":"Manage Cards"},{"type":"link","url":"/cards-api/walkthrough/card-from-payment-id","title":"Create a Card on File from Payment ID"},{"type":"link","url":"/cards-api/walkthrough-seller-card","title":"Create a Card on File and Make a Payment"},{"type":"link","url":"/cards-api/walkthrough-shared-card","title":"Create a Shared Card on File and Make a Payment"}],"title":"Cards","url":"/cards-api/overview"},{"id":"3oWs4JO3JfhkfDcUEhNGeJ","type":"subcategory","items":[{"type":"link","url":"/payouts-api/list-payouts","title":"List Payouts"},{"type":"link","url":"/payouts-api/get-payout","title":"Get Payout"},{"type":"link","url":"/payouts-api/list-payout-entries","title":"List Payout Entries"}],"title":"Payouts","url":"/payouts-api/overview"},{"type":"link","url":"/bank-accounts-api","title":"Bank Accounts"},{"id":"7re5dyp7kQZpvvwAJUee93","type":"subcategory","items":[{"type":"link","url":"/mobile-authz/how-it-works","title":"How It Works"},{"type":"link","url":"/mobile-authz/build-with-mobile-authz","title":"Build with Mobile Authorization"},{"type":"link","url":"/mobile-authz/cookbook/mobile-code-with-curl","title":"Get Authorization Code on Command Line"}],"title":"Mobile Authorization","url":"/mobile-authz/what-it-does"},{"type":"divider","style":"divider"},{"type":"link","url":"/payment-card-support-by-country","title":"Payment Methods by Country"},{"type":"link","url":"/payments-pricing","title":"Payments Pricing"},{"type":"link","url":"/sca-overview","title":"Strong Customer Authentication"},{"type":"link","url":"/payment-minimums","title":"Payment Minimums"}],"title":"Payments","url":"/payments-overview"},{"id":"3NKV9K0UfSbHh8odPIJR1c","type":"subcategory","items":[{"type":"link","url":"/commerce","title":"Overview"},{"id":"4F79mKtS4eqZigce67OxFF","type":"subcategory","items":[{"type":"link","url":"/commerce/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/commerce/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/commerce/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/commerce-scenarios"},{"id":"1fQKpXBuZJnPgVRaDRKLg0","type":"subcategory","items":[{"type":"link","url":"/orders-api/create-orders","title":"Create Orders"},{"type":"link","url":"/orders-api/manage-orders/update-orders","title":"Update Orders"},{"type":"link","url":"/orders-api/manage-orders/search-orders","title":"Search Orders"},{"type":"link","url":"/orders-api/manage-orders/retrieve-orders","title":"Retrieve Orders"},{"id":"3actPvHZPDJZx122xWJpED","type":"subcategory","items":[{"type":"link","url":"/orders-api/apply-taxes-and-discounts/auto-apply-discounts","title":"Apply Square-Defined Discounts"},{"type":"link","url":"/orders-api/apply-taxes-and-discounts/auto-apply-taxes","title":"Apply Catalog Taxes to Orders"}],"title":"Apply Catalog Taxes and Discounts","url":"/orders-api/apply-taxes-and-discounts"},{"id":"ebWImqVQwkBx3xfF0lbvb","type":"subcategory","items":[{"type":"link","url":"/orders-api/discounts","title":"Order Discounts"},{"type":"link","url":"/orders-api/taxes","title":"Order Taxes"},{"type":"link","url":"/orders-api/service-charges","title":"Order Service Charges"}],"title":"Order Price Adjustments","url":"/orders-api/price-adjustments"},{"type":"link","url":"/orders-api/pay-for-orders","title":"Pay for Orders"},{"type":"divider","style":"divider"},{"type":"link","url":"/orders-api/order-returns-exchanges","title":"Refunds and Exchanges"},{"type":"link","url":"/orders-api/fulfillments","title":"Manage Fulfillments"},{"type":"link","url":"/orders-api/how-it-works","title":"How It Works"},{"type":"link","url":"/orders-api/order-ahead-usecase","title":"Order-Ahead Use Case"},{"id":"7zVLALaKpsa7uX7WLYhQ8e","type":"subcategory","items":[{"type":"link","url":"/orders-api/quick-start/step-1","title":"Get Developer Credentials"},{"type":"link","url":"/orders-api/quick-start/step-2","title":"Configure the Sample Application"},{"type":"link","url":"/orders-api/quick-start/step-3","title":"Generate Test Catalog Items"},{"type":"link","url":"/orders-api/quick-start/step-4","title":"Take a Pickup Order"},{"type":"link","url":"/orders-api/quick-start/step-5","title":"Verify a Pickup Order"}],"title":"Order-Ahead Sample App","url":"/orders-api/quick-start"},{"type":"link","url":"/orders-api/metadata","title":"Metadata"}],"title":"Orders","url":"/orders-api/what-it-does"},{"id":"7uE6hgqgUI1iKEWFxYKPYb","type":"subcategory","items":[{"type":"link","url":"/orders-custom-attributes-api/custom-attribute-definitions","title":"Define Custom Attributes"},{"type":"link","url":"/orders-custom-attributes-api/custom-attributes","title":"Use Custom Attributes"}],"title":"Order Custom Attributes","url":"/orders-custom-attributes-api/overview"},{"id":"5uzyfjmBfADM23ka1K1pWH","type":"subcategory","items":[{"type":"link","url":"/catalog-api/design-a-catalog","title":"Design a Catalog"},{"type":"link","url":"/catalog-api/build-with-catalog","title":"Build a Catalog"},{"type":"link","url":"/catalog-api/update-catalog-objects","title":"Update Catalog Objects"},{"type":"link","url":"/catalog-api/retrieve-catalog-objects","title":"Retrieve Catalog Objects"},{"id":"XauByVgbcHPakYrcVm4lx","type":"subcategory","items":[{"type":"link","url":"/catalog-api/search-catalog-items","title":"Call SearchCatalogItems"},{"type":"link","url":"/catalog-api/search-catalog-objects","title":"Call SearchCatalogObjects"}],"title":"Search a Catalog","url":"/catalog-api/search-catalog"},{"type":"link","url":"/catalog-api/sync-with-external-system","title":"Synchronize Catalog with External Platform"},{"type":"link","url":"/catalog-api/archive-catalog-items","title":"Archive Catalog Items"},{"type":"link","url":"/catalog-api/delete-catalog-objects","title":"Delete Catalog Objects"},{"type":"link","url":"/catalog-api/categorize-catalog-items","title":"Categorize Catalog Items"},{"type":"link","url":"/catalog-api/enable-modifiers-on-items","title":"Enable Modifiers on Items"},{"type":"link","url":"/catalog-api/item-options","title":"Use Item Options"},{"id":"6lb9Ids2YTwmZdYSSWo9ZU","type":"subcategory","items":[{"type":"link","url":"/catalog-api/upload-and-attach-images","title":"Upload and Attach Images"},{"type":"link","url":"/catalog-api/manage-images","title":"Manage Images"}],"title":"Work with Images","url":"/catalog-api/cookbook/create-catalog-image"},{"type":"link","url":"/catalog-api/add-custom-attributes","title":"Add Custom Attributes"},{"id":"4uO79DXTpBj486wRLPVjD9","type":"subcategory","items":[{"type":"link","url":"/catalog-api/cookbook/auto-apply-discounts/volume-discounts","title":"Create Volume Discounts"},{"type":"link","url":"/catalog-api/cookbook/auto-apply-discounts/bundle-discounts","title":"Create Bundled Discounts"},{"type":"link","url":"/catalog-api/cookbook/auto-apply-discounts/timeframe-discounts","title":"Create Time-Based Discounts"},{"type":"link","url":"/catalog-api/configure-customer-group-discounts","title":"Create Customer Group Discounts"}],"title":"Configure Discounts","url":"/catalog-api/cookbook/auto-apply-discounts"},{"type":"link","url":"/catalog-api/cookbook/set-quick-amounts","title":"Configure Quick Payments"},{"type":"link","url":"/catalog-api/webhooks","title":"Use Webhooks"}],"title":"Catalog","url":"/catalog-api/what-it-does"},{"id":"1VGd8FbxwmjW0KMaajkmro","type":"subcategory","items":[{"type":"link","url":"/inventory-api/how-it-works","title":"How It Works"},{"type":"link","url":"/inventory-api/build-with-inventory","title":"Build an Inventory"},{"type":"link","url":"/inventory-api/enable-stock-conversion","title":"Enable Stock Conversion"},{"type":"link","url":"/inventory-api/cookbook/reconcile-computed-quantity","title":"Reconcile Inventory Counts"},{"type":"link","url":"/inventory-api/cookbook/retrieve-specific-instock-quantity","title":"Retrieve Inventory Counts"},{"type":"link","url":"/inventory-api/cookbook/inventory-change-history","title":"Inspect Inventory Changes"},{"type":"link","url":"/inventory-api/monitor-sold-out-status-on-item-variation","title":"Monitor Sold-out Item Variations"},{"type":"link","url":"/inventory-api/webhooks","title":"Handle Inventory Events"},{"type":"link","url":"/inventory-api/migrate-to-updated-api-entities","title":"Migrate to Updated API Entities"}],"title":"Inventory","url":"/inventory-api/what-it-does"},{"id":"1oCvFBbwIfvkgSqzjsVtl2","type":"subcategory","items":[{"type":"link","url":"/bookings-api/get-ready-to-use-the-api","title":"Basic Concepts"},{"type":"link","url":"/bookings-api/onboard-to-the-api","title":"Onboard to Square Appointments"},{"type":"link","url":"/bookings-api/use-the-api","title":"Create and Manage Bookings"},{"type":"link","url":"/bookings-api/use-webhooks","title":"Handle Event Notifications"}],"title":"Bookings","url":"/bookings-api/what-it-is"},{"id":"3IFs9Vd3B5uWf4LFR7k8EL","type":"subcategory","items":[{"type":"link","url":"/booking-custom-attributes-api/custom-attribute-definitions","title":"Manage Custom Attribute Definitions for Bookings"},{"type":"link","url":"/booking-custom-attributes-api/custom-attributes","title":"Manage Custom Attributes for Bookings"}],"title":"Booking Custom Attributes","url":"/booking-custom-attributes-api/overview"},{"id":"5XXuzzOGN1H5FPRGJcikVN","type":"subcategory","items":[{"type":"link","url":"/vendors-api/create-vendors","title":"Create Vendors"},{"type":"link","url":"/vendors-api/update-vendors","title":"Update Vendors"},{"type":"link","url":"/vendors-api/retrieve-vendors","title":"Retrieve Vendors"},{"type":"link","url":"/vendors-api/search-for-vendors","title":"Search for Vendors"},{"type":"link","url":"/vendors-api/receive-vendors-events","title":"Receive Vendors Events"}],"title":"Vendors","url":"/vendors-api/manage-vendors-in-apps"},{"id":"1mKQKHnvTn1nAsKsA2JRCl","type":"subcategory","items":[{"id":"6bKuXUnDxmCCuIR7ihe7jW","type":"subcategory","items":[{"type":"link","url":"/sites-api/use-the-api","title":"Use the Sites API"}],"title":"Sites API","url":"/sites-api/overview"},{"id":"5Cl3kPc7CUDPgqnbaJBDVJ","type":"subcategory","items":[{"type":"link","url":"/snippets-api/use-the-api","title":"Use the Snippets API"},{"type":"link","url":"/snippets-api/add-a-snippet","title":"Add a Snippet to a Site"}],"title":"Snippets API","url":"/snippets-api/overview"}],"title":"Square Online","url":"/online-api"},{"type":"link","url":"/cashdrawershift-api/reporting","title":"Cash Drawer Shifts"}],"title":"Commerce","url":"/commerce"},{"id":"4URmYFehLwquxQBCQKBKSx","type":"subcategory","items":[{"type":"link","url":"/customers","title":"Overview"},{"id":"5A6vAFRO33giYriws2hfBB","type":"subcategory","items":[{"type":"link","url":"/customers/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/customers/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/customers/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/customers/scenarios"},{"id":"15dy7EMFV93TibH1VXLeuV","type":"subcategory","items":[{"type":"link","url":"/customers-api/how-it-works","title":"Customers API Workflows"},{"type":"link","url":"/customers-api/use-the-api/keep-records","title":"Manage Customer Profiles"},{"type":"link","url":"/customers-api/use-the-api/retrieve-profiles","title":"Retrieve Customer Profiles"},{"type":"link","url":"/customers-api/use-the-api/search-customers","title":"Search for Customer Profiles"},{"type":"link","url":"/customers-api/use-the-api/integrate-with-other-services","title":"Integrate with Other Services"},{"type":"link","url":"/customers-api/use-the-api/customer-webhooks","title":"Use Customer Webhooks"}],"title":"Customers","url":"/customers-api/what-it-does"},{"id":"76835s9ZeAgwsAQ3g4bAGW","type":"subcategory","items":[{"type":"link","url":"/customer-custom-attributes-api/custom-attribute-definitions","title":"Manage Customer Custom Attribute Definitions"},{"type":"link","url":"/customer-custom-attributes-api/custom-attributes","title":"Manage Customer Custom Attributes"}],"title":"Customer Custom Attributes","url":"/customer-custom-attributes-api/overview"},{"id":"3o5YnQHQmUFb3JPaTZB1DC","type":"subcategory","items":[{"type":"link","url":"/customer-groups-api/how-to-use-it","title":"Use Customer Groups"}],"title":"Customer Groups","url":"/customer-groups-api/what-it-does"},{"id":"1sYaoLP7iJ1tVaklA24liK","type":"subcategory","items":[{"type":"link","url":"/customer-segments-api/how-to-use-it","title":"Use Customer Segments"}],"title":"Customer Segments","url":"/customer-segments-api/what-it-does"},{"id":"JVl8yM8tzLNaxzj7qZtMM","type":"subcategory","items":[{"type":"link","url":"/loyalty/overview","title":"Loyalty Program Overview"},{"type":"link","url":"/loyalty-api/loyalty-programs","title":"Retrieve Loyalty Program"},{"type":"link","url":"/loyalty-api/loyalty-promotions","title":"Manage Loyalty Promotions"},{"type":"link","url":"/loyalty-api/loyalty-accounts","title":"Create and Retrieve Loyalty Accounts"},{"type":"link","url":"/loyalty-api/loyalty-points","title":"Manage Loyalty Points"},{"type":"link","url":"/loyalty-api/loyalty-rewards","title":"Manage Loyalty Rewards"},{"type":"link","url":"/loyalty-api/loyalty-events","title":"Search for Loyalty Events"},{"id":"1y9o6Z4aUBI2x7iBbs7dem","type":"subcategory","items":[{"type":"link","url":"/loyalty-api/walkthrough1/setup-loyalty-program","title":"Set up a Loyalty Program"},{"type":"link","url":"/loyalty-api/walkthrough1/enroll-buyer","title":"Enroll a Buyer"},{"type":"link","url":"/loyalty-api/walkthrough1/accrue-points","title":"Accumulate Points"},{"type":"link","url":"/loyalty-api/walkthrough1/redeem-points","title":"Redeem Points"}],"title":"Loyalty Walkthrough 1","url":"/loyalty-api/walkthrough1"},{"id":"11C6YxWjq6Ln0oPvOntZIE","type":"subcategory","items":[{"type":"link","url":"/loyalty-api/walkthrough2-setup-loyalty-program","title":"Set up a Loyalty Program"},{"type":"link","url":"/loyalty-api/walkthrough2-enroll-buyer","title":"Enroll a Buyer"},{"type":"link","url":"/loyalty-api/walkthrough2-accrue-points","title":"Adjust Points"},{"type":"link","url":"/loyalty-api/walkthrough2-redeem-points","title":"Redeem Points"}],"title":"Loyalty Walkthrough 2","url":"/loyalty-api/walkthrough2"}],"title":"Loyalty","url":"/loyalty-api/overview"},{"id":"SkbBIiQbMBmohDyoTixOJ","type":"subcategory","items":[{"type":"link","url":"/gift-cards/sell-gift-cards","title":"Sell Gift Cards"},{"type":"link","url":"/gift-cards/reload-gift-cards","title":"Reload Gift Cards"},{"type":"link","url":"/gift-cards/redeem-gift-cards","title":"Redeem Gift Cards"},{"type":"link","url":"/gift-cards/retrieve-gift-cards-and-activities","title":"Retrieve Gift Cards and Track Activity"},{"type":"link","url":"/gift-cards/manage-gift-cards-on-file","title":"Manage Gift Cards on File"},{"id":"6jk6v9WCq58u7FwD9THjoZ","type":"subcategory","items":[{"type":"link","url":"/gift-cards/walkthrough-1-with-orders-api","title":"Sell a Gift Card (Orders API Integration)"},{"type":"link","url":"/gift-cards/walkthrough-1-without-orders-api","title":"Sell a Gift Card (Custom Processing System)"}],"title":"Walkthrough 1: Sell a Gift Card","url":"/gift-cards/walkthrough-1"},{"id":"3dKyCAtUVMdrXS6NlwDLHz","type":"subcategory","items":[{"type":"link","url":"/gift-cards/walkthrough-2-orders-and-payments-integration","title":"Use a Gift Card (Orders and Payments APIs Integration)"},{"type":"link","url":"/gift-cards/walkthrough-2-custom-processing-system","title":"Use a Gift Card (Custom Processing System)"}],"title":"Walkthrough 2: Use a Gift Card","url":"/gift-cards/walkthrough-2"},{"type":"link","url":"/gift-cards/webhooks","title":"Webhooks"}],"title":"Gift Cards","url":"/gift-cards/using-gift-cards-api"}],"title":"Customers","url":"/customers"},{"id":"1ThKdZQl6m1Eioed7ZwOsS","type":"subcategory","items":[{"type":"link","url":"/staff","title":"Overview"},{"id":"6mOVdvn1uSAoAb8iJaDzEo","type":"subcategory","items":[{"type":"link","url":"/staff/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/staff/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/staff/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/staff/scenarios"},{"id":"2nH2TMoml4cRDkyaLvM892","type":"subcategory","items":[{"type":"link","url":"/team/integration","title":"Integration Guide"},{"type":"link","url":"/team/troubleshooting","title":"Troubleshoot Team API"}],"title":"Team","url":"/team/overview"},{"id":"4onB3obwWl1foVPal7Sq8X","type":"subcategory","items":[{"type":"link","url":"/labor-api/build-with-labor","title":"Build with Labor"},{"type":"link","url":"/labor-api/cookbook/add-shift-breaks","title":"Add Shift Breaks"},{"type":"link","url":"/labor-api/cookbook/get-completed-shifts","title":"Get Completed Shifts"},{"type":"link","url":"/labor-api/how-it-works","title":"How It Works"},{"type":"link","url":"/labor-api/troubleshooting","title":"Troubleshoot"},{"type":"link","url":"/labor-api/webhooks","title":"Webhooks"}],"title":"Labor","url":"/labor-api/what-it-does"}],"title":"Staff","url":"/staff"},{"id":"5BHWPSspAJWZD75mfWezwx","type":"subcategory","items":[{"type":"link","url":"/merchant-details","title":"Overview"},{"id":"3OwozWeQAYofh9tmoyrEPq","type":"subcategory","items":[{"type":"link","url":"/merchants/scenarios/tip-reporting","title":"Build a Tip Report"},{"type":"link","url":"/merchants/scenarios/split-online-payment","title":"Split an Online Payment"},{"type":"link","url":"/merchants/scenarios/simple-sales-report","title":"Build a Sales Report"}],"title":"Technical Scenarios","url":"/merchants/scenarios"},{"type":"link","url":"/merchants-api","title":"Merchants"},{"id":"3busOpLCt9zKcYBv4DnkxZ","type":"subcategory","items":[{"type":"link","url":"/merchant-custom-attributes-api/custom-attribute-definitions","title":"Define Custom Attributes for Merchants"},{"type":"link","url":"/merchant-custom-attributes-api/custom-attributes","title":"Use Custom Attributes for Merchants"}],"title":"Merchant Custom Attributes","url":"/merchant-custom-attributes-api/overview"},{"type":"link","url":"/locations-api","title":"Locations"},{"id":"3OtQbV9DLTefjKNm185T2k","type":"subcategory","items":[{"type":"link","url":"/location-custom-attributes-api/custom-attribute-definitions","title":"Define Custom Attributes for Locations"},{"type":"link","url":"/location-custom-attributes-api/custom-attributes","title":"Use Custom Attributes for Locations"}],"title":"Location Custom Attributes","url":"/location-custom-attributes-api/overview"}],"title":"Merchants","url":"/merchant-details"},{"type":"divider","style":"divider"},{"id":"2FhNpYU8iPn0qCJYFJureL","type":"subcategory","items":[{"id":"4dMAnH4WGqOuZx7AQsbW6W","type":"subcategory","items":[{"id":"3QpiaF1RqkIztw876w6vhH","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/what-should-i-build","title":"What Should I Build?"},{"id":"PkhOF4kBMi8AcjqYu6NjO","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/requirements/general","title":"General"},{"type":"link","url":"/app-marketplace/requirements/oauth-api","title":"OAuth API"},{"type":"link","url":"/app-marketplace/requirements/locations-api","title":"Locations API"},{"type":"link","url":"/app-marketplace/requirements","title":" ---------------"},{"type":"link","url":"/app-marketplace/requirements/app-subscriptions","title":"App Subscriptions"},{"type":"link","url":"/app-marketplace/requirements/bookings-api","title":"Bookings API"},{"type":"link","url":"/app-marketplace/requirements/catalog-api","title":"Catalog and Inventory API"},{"type":"link","url":"/app-marketplace/requirements/customers-api","title":"Customers API"},{"type":"link","url":"/app-marketplace/requirements/invoices-api","title":"Invoices API"},{"type":"link","url":"/app-marketplace/requirements/gift-cards-api","title":"Gift Cards API"},{"type":"link","url":"/app-marketplace/requirements/labor-api","title":"Labor API"},{"type":"link","url":"/app-marketplace/requirements/loyalty-api","title":"Loyalty API"},{"type":"link","url":"/app-marketplace/requirements/orders-api","title":"Orders API"},{"type":"link","url":"/app-marketplace/requirements/payments-api","title":"Payments"},{"type":"link","url":"/app-marketplace/requirements/payouts-api","title":"Payouts API"},{"type":"link","url":"/app-marketplace/requirements/snippets-api","title":"Snippets API"},{"type":"link","url":"/app-marketplace/requirements/subscriptions-api","title":"Subscriptions API"},{"type":"link","url":"/app-marketplace/requirements/team-api","title":"Team API"},{"type":"link","url":"/app-marketplace/requirements/terminal-api","title":"Terminal API"},{"type":"link","url":"/app-marketplace/requirements/webhooks","title":"Webhooks"}],"title":"Requirements","url":"/app-marketplace/requirements"},{"type":"link","url":"/app-marketplace/video-submission","title":"Video Submission Requirements"}],"title":"Build an App","url":"/app-marketplace/build"},{"id":"24UhdFmhHPDXsMEzIJ6OG4","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/listing-best-practices/basics","title":"Basic Information"},{"type":"link","url":"/app-marketplace/listing-best-practices/details","title":"Details"},{"type":"link","url":"/app-marketplace/listing-best-practices/get-started","title":"Get Started"},{"type":"link","url":"/app-marketplace/listing-best-practices/pricing","title":"Pricing"},{"type":"link","url":"/app-marketplace/listing-best-practices/brand-and-images","title":"Brand and Images"},{"type":"link","url":"/app-marketplace/listing-best-practices/support-information","title":"Support Information"}],"title":"Create an App Marketplace Listing","url":"/app-marketplace/listing-best-practices"},{"id":"4iCpNMONaJXwer69vlZd8Y","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/rev-share","title":"App Marketplace Revenue Sharing"},{"type":"link","url":"/app-marketplace/referral-tracking-links","title":"Referral Tracking Links"},{"id":"1el38dmWf4nbVIBAf60U2Q","type":"subcategory","items":[{"type":"link","url":"/app-marketplace/app-subscriptions/billing","title":"App Subscriptions Billing"}],"title":"App Subscriptions","url":"/app-marketplace/app-subscriptions"}],"title":"Monetize your Application","url":"/app-marketplace/earn-and-share"},{"type":"link","url":"/app-marketplace/promote-your-app","title":"Promote your App"},{"type":"link","url":"/app-marketplace/app-reviews","title":"App Marketplace Reviews"},{"type":"link","url":"/app-marketplace/faq","title":"App Marketplace Frequently Asked Questions"}],"title":"App Marketplace","url":"/app-marketplace"}],"title":"Publish","url":"/app-marketplace"},{"type":"divider","style":"space"},{"type":"divider","style":"divider"},{"id":"347zcabrwZkdfbgVsDmSBO","type":"subcategory","items":[{"type":"link","url":"/release-notes","title":"Overview"},{"type":"link","url":"/changelog/connect","title":"Square APIs and SDKs"},{"type":"link","url":"/changelog/mobile","title":"Mobile SDKs"},{"id":"6QrXNH8opd01JmuzgLjUXU","type":"subcategory","items":[{"type":"link","url":"/changelog/webpaymentsdk","title":"Web Payments SDK"},{"type":"link","url":"/changelog/paymentform","title":"Payment Form"}],"title":"Web SDKs","url":"/changelog/websdks"},{"type":"link","url":"/changelog/requirements","title":"App Marketplace Requirements"}],"title":"Release notes","url":"/release-notes"}]}},"notFound":false,"preview":false,"didRedirect":false}},"_sentryTraceData":"c162ddcf205f42b6879897fb52953e9c-a051ef8e1fe809f9-1","_sentryBaggage":"sentry-environment=production,sentry-release=45a671e198d332b37aa8aed10a78e8aa8544f793,sentry-public_key=94d09c8eb5834eb282d762cecbbd40e6,sentry-trace_id=c162ddcf205f42b6879897fb52953e9c,sentry-sample_rate=1,sentry-transaction=%2Fdocs%2F%5B%5B...slug%5D%5D,sentry-sampled=true"}},"page":"/docs/[[...slug]]","query":{"slug":["customers"]},"buildId":"45a671e198d332b37aa8aed10a78e8aa8544f793","assetPrefix":"https://dex-tech-fe-production-c.squarecdn.com/main","isFallback":false,"dynamicIds":[99726],"gip":true,"scriptLoader":[]}</script></body></html>