{"id":38961947,"url":"https://github.com/onready/vtex-node-sdk","last_synced_at":"2026-01-17T16:25:33.252Z","repository":{"id":40764259,"uuid":"272759427","full_name":"onready/vtex-node-sdk","owner":"onready","description":"VTEX Node SDK, built 100% with Typescript and 0 dependencies!","archived":false,"fork":false,"pushed_at":"2023-01-07T19:11:42.000Z","size":890,"stargazers_count":30,"open_issues_count":15,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-09-16T00:16:50.015Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@onreadydesa/vtex-node-sdk","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onready.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-16T16:32:18.000Z","updated_at":"2025-08-04T00:30:29.000Z","dependencies_parsed_at":"2023-02-07T22:16:08.924Z","dependency_job_id":null,"html_url":"https://github.com/onready/vtex-node-sdk","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/onready/vtex-node-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onready%2Fvtex-node-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onready%2Fvtex-node-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onready%2Fvtex-node-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onready%2Fvtex-node-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onready","download_url":"https://codeload.github.com/onready/vtex-node-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onready%2Fvtex-node-sdk/sbom","scorecard":{"id":707663,"data":{"date":"2025-08-11","repo":{"name":"github.com/onready/vtex-node-sdk","commit":"fa39c79a18af4badd259056a87732e4eaca55e7f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/8 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/node.js.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/onready/vtex-node-sdk/node.js.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/onready/vtex-node-sdk/node.js.yml/master?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"32 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T07:10:05.312Z","repository_id":40764259,"created_at":"2025-08-22T07:10:05.312Z","updated_at":"2025-08-22T07:10:05.312Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28511861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T13:38:16.342Z","status":"ssl_error","status_checked_at":"2026-01-17T13:37:44.060Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2026-01-17T16:25:33.155Z","updated_at":"2026-01-17T16:25:33.230Z","avatar_url":"https://github.com/onready.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/a/a9/VTEX_Logo.svg/1200px-VTEX_Logo.svg.png\" width=\"300\" alt=\"VTEX Logo\" style=\"margin-right: 20px\" /\u003e\n  \u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/d/d9/Node.js_logo.svg/1200px-Node.js_logo.svg.png\" width=\"200\" alt=\"Node Logo\" style=\"margin-left: 20px\" /\u003e\n  \n\u003c/p\u003e\n\n## VTEX NODE SDK\n\n\u003cp\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@onreadydesa/vtex-node-sdk\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@onreadydesa/vtex-node-sdk\" alt=\"npm version\" height=\"20\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/onready/vtex-node-sdk/workflows/Node.js%20CI/badge.svg\" alt=\"node-js-ci\" height=\"20\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/dm/@onreadydesa/vtex-node-sdk\" alt=\"downloads\" height=\"20\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/l/@onreadydesa/vtex-node-sdk\" alt=\"license\" height=\"20\"\u003e\n\u003c/p\u003e\n\n- :hammer: Built 100% with Typescript.\n- :muscle: 0 dependencies. It uses the native `https` Node module.\n- :tada: Promise based.\n- :dizzy: Type definitions for many VTEX requests and responses.\n\n\u003cins\u003e**Note**\u003c/ins\u003e: *\u003cstrong\u003eThis is not a VTEX official package, we are VTEX Partners since 2017 and we developed this to collaborate with VTEX Community.\u003c/strong\u003e*\n\n### Requirements\n\n- Node version \u003e= 8\n\n### Installation\n\n```\nnpm install @onreadydesa/vtex-node-sdk --save\n```\n\nor\n\n```\nyarn add @onreadydesa/vtex-node-sdk\n```\n\n### Basic usage example\n\nFirst, import the SDK:\n\n```javascript\nconst { VTEX } = require('@onreadydesa/vtex-node-sdk');\n```\n\n##### Using ES6 imports\n```javascript\nimport { VTEX } from '@onreadydesa/vtex-node-sdk';\n```\n\nThen, use the SDK like this:\n\n```javascript\nconst vtex = new Vtex('store name', 'app key', 'app token');\n\n// Get order by id\nvtex.oms.orders.getOrder('orderId')\n  .then((response) =\u003e {\n    console.log(response.status); // 200\n    console.log(response.body); // { orderId: 'orderId', ... }\n  })\n  .catch((error) =\u003e {\n    console.log(error.status);\n    console.log(error.body);\n  })\n```\n\n##### Using `async`/`await`\n\n```javascript\ntry {\n  const response = await vtex.oms.orders.getOrder('orderId');\n  console.log(response);\n} catch (error) {\n  console.log(error);\n}\n```\n\n### VTEX Environments\n\nBy 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:\n\n```javascript\nconst { VTEX } = require('@onreadydesa/vtex-node-sdk')\n\nconst vtex = new Vtex('store name', 'app key', 'app token', 'beta');\n```\n\n### Current implemented APIS\n\nThe final goal is to implement all VTEX Rest Apis. Feel free to contribute.\n\nAPI | Implemented\n:------------: | :-------------:|\nOMS | :white_check_mark: |\nLogistics | :white_check_mark: |\nPricing  | :white_check_mark: |\nMaster Data (V2) | :white_check_mark: (*) \u003cem\u003eAttachments API pending\u003c/em\u003e |\nCatalog | :white_check_mark: |\nSearch  | :white_check_mark: |\nPayments Gateway  | :white_check_mark: |\nSuggestions  | :white_check_mark: |\nVTEX DO  | :white_check_mark: |\nCMS | :white_check_mark: |\nSession Manager  | :white_check_mark: |\nLicense Manager | :white_check_mark: |\nCustomer Credit | :white_check_mark: |\nSubscriptions (V2)  | :white_check_mark: |\nRates and Benefits  | :white_check_mark: |\nCheckout | :white_check_mark: |\nGiftcard Hub | :white_check_mark:  |\nAntifraud Provider | :x: |\nGiftcard | :x: |\nGiftcard Provider Protocol | :x: |\nPayment Provider Protocol  | :x: |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonready%2Fvtex-node-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonready%2Fvtex-node-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonready%2Fvtex-node-sdk/lists"}