{"version":1,"pages":[{"id":"Il7EMMafKSTozK3WHvuI","title":"Shopwaive REST API","pathname":"/","siteSpaceId":"sitesp_kfksz","description":"The Shopwaive API reads and changes your customers' Shopwaive balances. 2026-11 is the current release; the classic routes (no version in the path) are deprecated"},{"id":"DdeOtsYAiXYscR6oKtiu","title":"Quick Start","pathname":"/quick-start","siteSpaceId":"sitesp_kfksz","description":"With this Quick Start guide, make your first request in just minutes"},{"id":"KJxI77QcFaiKm5vlCDAK","title":"API keys and Shopify expiring tokens","pathname":"/api-keys-and-shopify-expiring-tokens","siteSpaceId":"sitesp_kfksz","description":"Why the Shopwaive API uses API keys now, and how to move an integration off an old store access token"},{"id":"wqWHmPaCDpb8llvV1e3U","title":"Shopwaive API 2026-11","pathname":"/api-2026-11","siteSpaceId":"sitesp_kfksz","description":"The Shopwaive API 2026-11: every request with its typed fields, enums, answers and errors."},{"id":"qyf7mxPf65DgZEPS0jWm","title":"Reference","pathname":"/api-2026-11/reference","siteSpaceId":"sitesp_kfksz","description":"Every request of the Shopwaive API 2026-11: its method, path, what it does and the scopes it needs.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"jh4aFnWGaYwz3GfMks4K","title":"Holders","pathname":"/api-2026-11/holders","siteSpaceId":"sitesp_kfksz","description":"Holders requests of the Shopwaive API 2026-11: every path, method, typed field, enum value and answer.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"KV2yeEKrbQuDRQsKYKTC","title":"Wallets","pathname":"/api-2026-11/wallets","siteSpaceId":"sitesp_kfksz","description":"Wallets requests of the Shopwaive API 2026-11: every path, method, typed field, enum value and answer.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"vL5ad1BOie60QDY73wdi","title":"Ledger","pathname":"/api-2026-11/ledger","siteSpaceId":"sitesp_kfksz","description":"Ledger requests of the Shopwaive API 2026-11: every path, method, typed field, enum value and answer.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"Af3iMXbQ1ioL3taBVYvE","title":"Orders","pathname":"/api-2026-11/orders","siteSpaceId":"sitesp_kfksz","description":"Orders requests of the Shopwaive API 2026-11: every path, method, typed field, enum value and answer.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"lVVEmekDPsEVV0tPjACT","title":"Redemptions","pathname":"/api-2026-11/redemptions","siteSpaceId":"sitesp_kfksz","description":"Redemptions requests of the Shopwaive API 2026-11: every path, method, typed field, enum value and answer.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"ao2pGx4gJ6fGS17NVTFF","title":"Store","pathname":"/api-2026-11/store","siteSpaceId":"sitesp_kfksz","description":"Store requests of the Shopwaive API 2026-11: every path, method, typed field, enum value and answer.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"yaHYD5RY3G07Pq0BTEP6","title":"Shopify store credit","pathname":"/api-2026-11/shopify-store-credit","siteSpaceId":"sitesp_kfksz","description":"Shopify store credit requests of the Shopwaive API 2026-11: every path, method, typed field, enum value and answer.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"6tXHXhbsY03Baq7uEMcI","title":"Versions","pathname":"/api-2026-11/versions","siteSpaceId":"sitesp_kfksz","description":"Versions requests of the Shopwaive API 2026-11: every path, method, typed field, enum value and answer.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"UoDkR7b6RZlMXUv2W0Or","title":"Schemas","pathname":"/api-2026-11/schemas","siteSpaceId":"sitesp_kfksz","description":"Every object of the Shopwaive API 2026-11 with its typed fields and enum values, as in its OpenAPI file.","breadcrumbs":[{"label":"Shopwaive API 2026-11"}]},{"id":"whENBLdBov3xADoyOjiG","title":"Authentication","pathname":"/authentication","siteSpaceId":"sitesp_kfksz","description":"How a request of the Shopwaive API 2026-11 sends its key: the one header, the scopes, and the older header names."},{"id":"AKZGhms9bEx16is07GeG","title":"Getting started for developer teams","pathname":"/getting-started-for-developer-teams","siteSpaceId":"sitesp_kfksz","description":"Getting started for developer teams: the path for an agency or an in-house team, from a sandbox with a seat and a test key for each developer to a live key with only the scopes the integration needs"},{"id":"MiVSLAyHrlWZ8ePPD80G","title":"Developer tools","pathname":"/developer-tools","siteSpaceId":"sitesp_kfksz","description":"Developer tools in the Shopwaive app: the MCP server, the Shopwaive API 2026-11, the command line, the client library, your API keys and sandboxes. What each tab does and where to start."},{"id":"QOQHeEZxsykLZUUklMxV","title":"Quickstart","pathname":"/developer-tools/quickstart","siteSpaceId":"sitesp_kfksz","description":"From turning on Developer tools to a first request with a test key, then a live key with only the scopes your integration needs","breadcrumbs":[{"label":"Developer tools"}]},{"id":"tM4RXfDhTxXcrl7H3E00","title":"MCP","pathname":"/developer-tools/mcp","siteSpaceId":"sitesp_kfksz","description":"The MCP tab of Developer tools: the Shopwaive MCP server's address, the key an AI assistant sends, and how to connect an MCP client","breadcrumbs":[{"label":"Developer tools"}]},{"id":"IRTCppJBCh5ElKMYgnoX","title":"API","pathname":"/developer-tools/api","siteSpaceId":"sitesp_kfksz","description":"The API tab of Developer tools: a first request ready to copy, the API explorer and the webhook tester","breadcrumbs":[{"label":"Developer tools"}]},{"id":"NcIZfZ1OilFvigciryo0","title":"CLI","pathname":"/developer-tools/cli","siteSpaceId":"sitesp_kfksz","description":"The CLI tab of Developer tools: call the Shopwaive API 2026-11 from your terminal with cURL, with your key kept in an environment variable","breadcrumbs":[{"label":"Developer tools"}]},{"id":"ula4e4jr4KbLRHVgkAtW","title":"Client library","pathname":"/developer-tools/client-library","siteSpaceId":"sitesp_kfksz","description":"The Client library tab of Developer tools: the first request of the Shopwaive API 2026-11 in Node, Python and Go, with no SDK to install","breadcrumbs":[{"label":"Developer tools"}]},{"id":"evPsBW8clpfsY0I1rOni","title":"API keys","pathname":"/developer-tools/api-keys","siteSpaceId":"sitesp_kfksz","description":"The API keys tab of Developer tools: every live and test key of your store in one list; create, rotate and revoke a key","breadcrumbs":[{"label":"Developer tools"}]},{"id":"kRnzmqJ1g4R89cC6Zoqy","title":"Sandbox","pathname":"/developer-tools/sandbox","siteSpaceId":"sitesp_kfksz","description":"Sandboxes: test copies of your Shopwaive account, with test customers, test balances, test keys and test tools. Nothing in a sandbox is real.","breadcrumbs":[{"label":"Developer tools"}]},{"id":"AVueI8VJdUdyoV3Ua7Oy","title":"Create a sandbox","pathname":"/developer-tools/sandbox/create","siteSpaceId":"sitesp_kfksz","description":"Create a sandbox in Developer tools: its name and its starting test data","breadcrumbs":[{"label":"Developer tools"},{"label":"Sandbox"}]},{"id":"X6WLpkmrjU6HZwc0OGXv","title":"Seats and test keys","pathname":"/developer-tools/sandbox/seats-and-test-keys","siteSpaceId":"sitesp_kfksz","description":"Seats and test keys: one seat for each developer in a sandbox, and the test keys that reach only the sandbox's test data","breadcrumbs":[{"label":"Developer tools"},{"label":"Sandbox"}]},{"id":"otYweXSWJfysOEEQjeYK","title":"Test tools","pathname":"/developer-tools/sandbox/test-tools","siteSpaceId":"sitesp_kfksz","description":"Test tools: make the cases your integration has to handle in a sandbox, one request each, on test data only","breadcrumbs":[{"label":"Developer tools"},{"label":"Sandbox"}]},{"id":"gNg5p7P6b5OoJvOmav1O","title":"Errors","pathname":"/reference/errors","siteSpaceId":"sitesp_kfksz","description":"Every error of the Shopwaive API 2026-11: the error object, the status codes, and each error code with what to do next.","breadcrumbs":[{"label":"Reference"}]},{"id":"hgeTn2rsRK9VnlNUyAEF","title":"Classic REST API","pathname":"/reference/rest-api-documentation","siteSpaceId":"sitesp_kfksz","description":"The classic routes of the Shopwaive API, with no version in the path: every request, how to test it with your own key, and the errors","breadcrumbs":[{"label":"Reference"}]},{"id":"jxHQxmtKxdciiLxDXjY5","title":"Customer API","pathname":"/reference/rest-api-documentation/customer-api","siteSpaceId":"sitesp_kfksz","description":"Read a customer's balance, set it, or add to it and take from it with the Shopwaive Customer API","breadcrumbs":[{"label":"Reference"},{"label":"Classic REST API"}]},{"id":"y8ShXE6jJ0ql9YZxKgue","title":"Action API","pathname":"/reference/rest-api-documentation/action-api","siteSpaceId":"sitesp_kfksz","description":"Read, update and delete the entries (actions) that make up a customer's balance with the Shopwaive Action API","breadcrumbs":[{"label":"Reference"},{"label":"Classic REST API"}]},{"id":"6xfY6O1IbVlyY9wTejx9","title":"Loyalty API","pathname":"/reference/rest-api-documentation/loyalty-api","siteSpaceId":"sitesp_kfksz","description":"Read a store's loyalty program, its tiers, a member's points and history, and each order's points with the Shopwaive Loyalty API. Read only","breadcrumbs":[{"label":"Reference"},{"label":"Classic REST API"}]},{"id":"iSskK82Psa3ua96GhVJW","title":"Shopify Flow","pathname":"/reference/rest-api-documentation/shopify-flow","siteSpaceId":"sitesp_kfksz","description":"Start your Shopify Flow workflows from your own server with the Shopwaive HTTP POST trigger","breadcrumbs":[{"label":"Reference"},{"label":"Classic REST API"}]},{"id":"3BsZbZ0rV5REAArx4OfL","title":"Shopwaive API rate limits","pathname":"/reference/shopwaive-api-rate-limits","siteSpaceId":"sitesp_kfksz","description":"How many requests a second and a day the Shopwaive API takes, and what happens over a limit","breadcrumbs":[{"label":"Reference"}]},{"id":"5mQdJbP4G2SDBK1Rzk5j","title":"Move from the classic routes","pathname":"/guides/migrate-from-the-classic-routes","siteSpaceId":"sitesp_kfksz","description":"Move from the classic routes (no version in the path) to the Shopwaive API 2026-11: the 2026-11 request that replaces each one, and what changes","breadcrumbs":[{"label":"Guides"}]},{"id":"4jgjQKgLH5OUlWOgvlj3","title":"Classic routes (deprecated)","pathname":"/classic","siteSpaceId":"sitesp_ABoZF","description":"The Shopwaive API's classic routes (no version in the path), which are deprecated"},{"id":"Y32ERXCrszGbUHoo9jaV","title":"Quick Start","pathname":"/classic/quick-start","siteSpaceId":"sitesp_ABoZF","description":"With this Quick Start guide, make your first request in just minutes"},{"id":"du30UktlMIYJE5dEQk2w","title":"API keys and Shopify expiring tokens","pathname":"/classic/api-keys-and-shopify-expiring-tokens","siteSpaceId":"sitesp_ABoZF","description":"Why the Shopwaive API uses API keys now, and how to move an integration off an old store access token"},{"id":"m8u5aBY6z290RpSny4WO","title":"Classic REST API","pathname":"/classic/reference/rest-api-documentation","siteSpaceId":"sitesp_ABoZF","description":"The classic routes of the Shopwaive API, with no version in the path: every request, how to test it with your own key, and the errors","breadcrumbs":[{"label":"Reference"}]},{"id":"XvGJNtqjodgMN898v9dT","title":"Customer API","pathname":"/classic/reference/rest-api-documentation/customer-api","siteSpaceId":"sitesp_ABoZF","description":"Read a customer's balance, set it, or add to it and take from it with the Shopwaive Customer API","breadcrumbs":[{"label":"Reference"},{"label":"Classic REST API"}]},{"id":"0Lbxib0wzsAwkZPaqLlD","title":"Action API","pathname":"/classic/reference/rest-api-documentation/action-api","siteSpaceId":"sitesp_ABoZF","description":"Read, update and delete the entries (actions) that make up a customer's balance with the Shopwaive Action API","breadcrumbs":[{"label":"Reference"},{"label":"Classic REST API"}]},{"id":"VT4YGRlBj1nUHVkWObiy","title":"Loyalty API","pathname":"/classic/reference/rest-api-documentation/loyalty-api","siteSpaceId":"sitesp_ABoZF","description":"Read a store's loyalty program, its tiers, a member's points and history, and each order's points with the Shopwaive Loyalty API. Read only","breadcrumbs":[{"label":"Reference"},{"label":"Classic REST API"}]},{"id":"fDIeE4GdpwOADxId7bly","title":"Shopify Flow","pathname":"/classic/reference/rest-api-documentation/shopify-flow","siteSpaceId":"sitesp_ABoZF","description":"Start your Shopify Flow workflows from your own server with the Shopwaive HTTP POST trigger","breadcrumbs":[{"label":"Reference"},{"label":"Classic REST API"}]},{"id":"fc7NXVSxATQDnUxV4ntk","title":"Shopwaive API rate limits","pathname":"/classic/reference/shopwaive-api-rate-limits","siteSpaceId":"sitesp_ABoZF","description":"How many requests a second each part of the Shopwaive API takes, and what happens over the limit","breadcrumbs":[{"label":"Reference"}]}]}