Use this JavaScript library to manage Square resources (such as payments, orders, items, and inventory) for your own Square account or on behalf of Square sellers.
Use of the Square Node.js SDK requires:
- Node.js 14 or higher
This SDK supports Node.js versions that are either current, or that are in long-term support status (LTS). The SDK does not support Node.js versions that have reached their end-of-life (EOL). For more information on Node.js versioning, see https://nodejs.org/en/about/releases/.
This SDK is for use with Node.js only. It does not support other usages, such as for web browsers or frontend applications.
For more information, see Set Up Your Square SDK for a Node.js Project.
For more information, see Square Node.js SDK Quickstart.
For more information, see Using the Square Node.js SDK.
First, clone the repo locally and cd into the directory.
git clone https://github.com/square/square-nodejs-sdk.git
cd square-nodejs-sdkNext, install dependencies and build.
npm install
npm run buildBefore running the tests, get a sandbox access token from your Developer Dashboard and use it to set a SQUARE_SANDBOX_TOKEN environment variable.
export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX ACCESS TOKEN HERE"And run the tests.
npm testThe following Square APIs are deprecated:
-
Employees - replaced by the Team API. For more information, see Migrate from the Employees API.
-
Transactions - replaced by the Orders and Payments APIs. For more information, see Migrate from the Transactions API.