square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

  • square

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
square
33.0.019 days ago12 years agoMinified + gzip package size for square in KB

Readme

Build npm version Apache-2 license
Square Node.js SDK
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.

Requirements

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 .
This SDK is for use with Node.js only. It does not support other usages, such as for web browsers or frontend applications.

Installation

For more information, see Set Up Your Square SDK for a Node.js Project.

Quickstart

For more information, see Square Node.js SDK Quickstart.

Usage

For more information, see Using the Square Node.js SDK.

Tests

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

SDK Reference

Payments

Terminal

Orders

Subscriptions

Invoices

Items

Customers

Loyalty

Gift Cards

Bookings

Business

Team

Financials

Online

Authorization

Webhook Subscriptions

Deprecated APIs

The following Square APIs are deprecated: