Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ScaleLeap/selling-partner-api-sdk
A fully typed TypeScript and Node.js SDK library for Amazon Selling Partner API
https://github.com/ScaleLeap/selling-partner-api-sdk
amazon-mws amazon-selling-partner amazon-sp-api selling-partner-api sp-api
Last synced: about 2 months ago
JSON representation
A fully typed TypeScript and Node.js SDK library for Amazon Selling Partner API
- Host: GitHub
- URL: https://github.com/ScaleLeap/selling-partner-api-sdk
- Owner: ScaleLeap
- License: mit
- Created: 2021-03-02T03:09:05.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T20:08:54.000Z (2 months ago)
- Last Synced: 2024-10-29T22:41:41.978Z (2 months ago)
- Topics: amazon-mws, amazon-selling-partner, amazon-sp-api, selling-partner-api, sp-api
- Language: TypeScript
- Homepage: https://npm.im/@scaleleap/selling-partner-api-sdk
- Size: 8.96 MB
- Stars: 67
- Watchers: 4
- Forks: 28
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-spapi - ScaleLeap - partner-api-sdk?style=plastic&logoWidth=1) (Docs / Library)
README
# Selling Partner API for Node.js
[](https://npm.im/@scaleleap/selling-partner-api-sdk)
[](./LICENSE)
[](https://github.com/ScaleLeap/selling-partner-api-sdk/actions)
[](https://codecov.io/gh/ScaleLeap/selling-partner-api-sdk)
[](https://snyk.io/test/github/scaleleap/selling-partner-api-sdk)
[](https://github.com/semantic-release/semantic-release)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FScaleLeap%2Fselling-partner-api-sdk?ref=badge_shield)
---
- A fully typed TypeScript and Node.js SDK package for Amazon Selling Partner API
- Uses models from [API model's repo](https://github.com/amzn/selling-partner-api-models) to generate classes automatically
- Picks up changes and releases daily when/if models have drifted
## Download & Installation
```sh
npm i -s @scaleleap/selling-partner-api-sdk
```
## Getting Started
### Prerequisites
A few things to get started:
- [Registering as a developer](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#registering-as-a-developer)
- [Registering your Hybrid Selling Partner API applications](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#hybrid-selling-partner-api-applications)
- [Authorizing Selling Partner API applications](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#authorizing-selling-partner-api-applications)
### Authorizing Selling Partner API
Note that it is outside the responsibility of this package to handle the authorization process.
This package assumes you have already acquired the access and refresh tokens either by going through
the OAuth flow or by using a self-authorized set of credentials.
### Basic Usage
```ts
import { SellersApiClient } from '@scaleleap/selling-partner-api-sdk'
const client = new SellersApiClient({
accessToken: 'Atza|...',
// Or use `amazonMarketplaces.CA.sellingPartner.region.endpoint`
// from `@scaleleap/amazon-marketplaces` package
basePath: 'https://sellingpartnerapi-na.amazon.com',
// Or use `amazonMarketplaces.CA.sellingPartner.region.awsRegion`
// from `@scaleleap/amazon-marketplaces` package
region: 'us-east-1',
})
const marketplaceParticipations = await client.getMarketplaceParticipations()
```
---
See the full list of exported classes and types:
[`src/api-models/index.ts`](src/api-models/index.ts).
See [@scaleleap/amazon-marketplaces](https://github.com/ScaleLeap/amazon-marketplaces)
docs for a database of constants about Amazon Marketplaces.
### Documentation
- [Automatically generated docs](https://selling-partner-api-sdk.scaleleap.org)
## Contributing
This repository uses [Conventional Commit](https://www.conventionalcommits.org/) style commit messages.
## Authors or Acknowledgments
- Roman Filippov ([Scale Leap](https://www.scaleleap.com))
- Toan Nguyen ([nguyentoanit](https://github.com/nguyentoanit))
## License
This project is licensed under the MIT License.
[](https://app.fossa.com/projects/git%2Bgithub.com%2FScaleLeap%2Fselling-partner-api-sdk?ref=badge_large)