@space48/bigcommerce-api
v0.3.1
Published
A JavaScript client for BigCommerce's [Management](src/management/README.md) API with full TypeScript typings for all API endpoints.
Downloads
3,669
Keywords
Readme
bigcommerce-api-js
A JavaScript client for BigCommerce's Management API with full TypeScript typings for all API endpoints.
Features
- Full coverage of BigCommerce's Storefront (coming soon) and Management APIs.
- Up-to-date TypeScript typings for all of BigCommerce's API endpoints.
- Easy IDE autocompeletion of endpoints, parameters and response data thanks to TypeScript.
- Automatic retry of intermittent errors such as 429 and 5xx with exponential backoff.
Coming soon
- Type declarations for webhook payloads.
- Browser support.
Supported environments
- Node.js >=10
- Browser support is coming soon.
Getting started
To get started with the JavaScript client you'll need to install it, and then follow the instructions for either the Storefront API client or the Management API client.
- Installation
- Getting started with the Storefront API client
- Getting started with the Management API client
Installation
Node
npm install @space48/bigcommerce-api
Browser
Coming soon.
Typings
This library also comes with typings to use with TypeScript.
Versioning
This project strictly follows Semantic Versioning.
Support
If you have a problem with this library, please file an issue here on GitHub.
Contributing
See CONTRIBUTING.md
License
MIT