https://github.com/onready/vtex-node-sdk
VTEX Node SDK, built 100% with Typescript and 0 dependencies!
https://github.com/onready/vtex-node-sdk
api-vtex node node-vtex node-vtex-sdk onready sdk-node-vtex sdk-vtex typescript vtex vtex-api vtex-node vtex-node-sdk vtex-sdk
Last synced: 5 months ago
JSON representation
VTEX Node SDK, built 100% with Typescript and 0 dependencies!
- Host: GitHub
- URL: https://github.com/onready/vtex-node-sdk
- Owner: onready
- License: mit
- Created: 2020-06-16T16:32:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T19:11:42.000Z (over 3 years ago)
- Last Synced: 2025-09-16T00:16:50.015Z (9 months ago)
- Topics: api-vtex, node, node-vtex, node-vtex-sdk, onready, sdk-node-vtex, sdk-vtex, typescript, vtex, vtex-api, vtex-node, vtex-node-sdk, vtex-sdk
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@onreadydesa/vtex-node-sdk
- Size: 869 KB
- Stars: 30
- Watchers: 5
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## VTEX NODE SDK
- :hammer: Built 100% with Typescript.
- :muscle: 0 dependencies. It uses the native `https` Node module.
- :tada: Promise based.
- :dizzy: Type definitions for many VTEX requests and responses.
**Note**: *This is not a VTEX official package, we are VTEX Partners since 2017 and we developed this to collaborate with VTEX Community.*
### Requirements
- Node version >= 8
### Installation
```
npm install @onreadydesa/vtex-node-sdk --save
```
or
```
yarn add @onreadydesa/vtex-node-sdk
```
### Basic usage example
First, import the SDK:
```javascript
const { VTEX } = require('@onreadydesa/vtex-node-sdk');
```
##### Using ES6 imports
```javascript
import { VTEX } from '@onreadydesa/vtex-node-sdk';
```
Then, use the SDK like this:
```javascript
const vtex = new Vtex('store name', 'app key', 'app token');
// Get order by id
vtex.oms.orders.getOrder('orderId')
.then((response) => {
console.log(response.status); // 200
console.log(response.body); // { orderId: 'orderId', ... }
})
.catch((error) => {
console.log(error.status);
console.log(error.body);
})
```
##### Using `async`/`await`
```javascript
try {
const response = await vtex.oms.orders.getOrder('orderId');
console.log(response);
} catch (error) {
console.log(error);
}
```
### VTEX Environments
By default, the SDK makes all requests to `vtexcommercestable` environment. If you want to use another environment (For example, `vtexcommercebeta`), you can pass an extra argument like this:
```javascript
const { VTEX } = require('@onreadydesa/vtex-node-sdk')
const vtex = new Vtex('store name', 'app key', 'app token', 'beta');
```
### Current implemented APIS
The final goal is to implement all VTEX Rest Apis. Feel free to contribute.
API | Implemented
:------------: | :-------------:|
OMS | :white_check_mark: |
Logistics | :white_check_mark: |
Pricing | :white_check_mark: |
Master Data (V2) | :white_check_mark: (*) Attachments API pending |
Catalog | :white_check_mark: |
Search | :white_check_mark: |
Payments Gateway | :white_check_mark: |
Suggestions | :white_check_mark: |
VTEX DO | :white_check_mark: |
CMS | :white_check_mark: |
Session Manager | :white_check_mark: |
License Manager | :white_check_mark: |
Customer Credit | :white_check_mark: |
Subscriptions (V2) | :white_check_mark: |
Rates and Benefits | :white_check_mark: |
Checkout | :white_check_mark: |
Giftcard Hub | :white_check_mark: |
Antifraud Provider | :x: |
Giftcard | :x: |
Giftcard Provider Protocol | :x: |
Payment Provider Protocol | :x: |