Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.
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:
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-sdk
Next, install dependencies and build.
npm install
npm run build
Before 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 test
The 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.
FAQs
Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.
The npm package square receives a total of 21,585 weekly downloads. As such, square popularity was classified as popular.
We found that square demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.