{"_id":"@woocommerce/woocommerce-rest-api","_rev":"41-844449935a4a24039e7d4b087ebb038a","name":"@woocommerce/woocommerce-rest-api","dist-tags":{"latest":"1.0.2"},"versions":{"0.0.1":{"name":"@woocommerce/woocommerce-rest-api","version":"0.0.1","keywords":["wordpress","woocommerce","rest","promise","node"],"author":{"name":"Automattic"},"license":"MIT","_id":"@woocommerce/woocommerce-rest-api@0.0.1","maintainers":[{"name":"albertjuhe","email":"contact@albertjuhe.com"},{"name":"mikejolley","email":"mikejolley86@gmail.com"},{"name":"psealock","email":"psealock@gmail.com"},{"name":"coderkevin","email":"kevin@redfenix.com"},{"name":"timmyc","email":"timmydcrawford@gmail.com"},{"name":"claudiosanches","email":"contato@claudiosanches.com"},{"name":"ryelle","email":"kelly.dwan@gmail.com"}],"homepage":"https://github.com/woocommerce/woocommerce-rest-api-js-lib","bugs":{"url":"https://github.com/woocommerce/woocommerce-rest-api-js/issues"},"dist":{"shasum":"9cbe8ea22d67e21ff6ad0710f09dcea7cc1e4858","tarball":"https://registry.npmjs.org/@woocommerce/woocommerce-rest-api/-/woocommerce-rest-api-0.0.1.tgz","fileCount":6,"integrity":"sha512-+sM+aXtMCjo5jNpK1eK9qcxmH/C/3GZkuHT702NNVsZR7ZmrFJegpEdpYLzTwjUXSC+6ON68hcpLS1ek5P2MVg==","signatures":[{"sig":"MEUCIQCRETD6drxSpNtacZU1aXAtaNZBYy0280JCiHjCehDeRQIgSS41arbWOKvZyUtEjpNcmo2OZvR8Fjej+QBS9sh9F5Q=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28059,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdP1RwCRA9TVsSAnZWagAALGwP/0KdQy/SdkfPI61P1FvL\np3OY1o4ksvBHMONdtwY+QHPXOds+CzlV5IZvYKRs5hIwLcJlVtESNjOI6t2Z\nVvBjD6vrlN3NJ9zYDI9AgD1/R2uFjSikxWy/h5I/c1Q1ZOz+90EgqMjKH2TN\n9I6bL9UoUpxG1NWdO6olEfAngxkNMApq4ODkeAWXakJgo0kfc7rPmhZSUm8o\nJMTFP9Qnq4McYvQ52MxQh556Ygw47/qYSuPL8Vj8Zd140B0hfGlMGYtyiFeQ\nSWYBKCePQ7vWbJD1UCdAveTJ0l3PEoBreWdMPwMCplYB+GRp663arAUQcMJT\nZoNAEjh7BQs+MeMspmOHGysLnb1BFa2iLZQXtPjj8LrB8uc+ucWNb4k33EMb\nlLYWmQWQr4Vdg8QAwoBYTKviGPQHWyw1w7dsAaS9YvC+gF/JYeZticgj4kEJ\nWyl5EnGcgepC3v5YnndSHrSq8bbvU3Hy6IbdsdGV0TWJc2bIz1B7o2rgWhpz\n5w7kk0c6KfFI/jkdFJkuEzruOja1d0MpHcPXQD1wnJfFe7Ohmdex2UQoUu3O\nbhA4XtubjDGZkhji5FN/fh+DV8ltdrZI1bm13vFkybNqJ9B0XCxWrfeA3xW0\njTQ9JqoYjBYArAOHUerXn6NafPMYg4idAO5SQ8EhRbzrToKX8lwVmn85rx42\n+zSK\r\n=RaGM\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index","husky":{"hooks":{"pre-commit":"lint-staged"}},"engines":{"node":">=8.0.0"},"gitHead":"1cd473e63757defc1969817bf2753ab3bfeac427","scripts":{"lint":"eslint *.mjs","test":"jest","build":"del index.js && babel index.mjs --out-dir .","format":"prettier --write \"*.mjs\" \"test.js\"","prepare":"npm run build","version":"npm run format && git add -A","preversion":"npm run lint","postversion":"git push && git push --tags","prepublishOnly":"npm test && npm run lint"},"_npmUser":{"name":"claudiosanches","email":"contato@claudiosanches.com"},"repository":{"url":"git+https://github.com/woocommerce/woocommerce-rest-api-js.git","type":"git"},"_npmVersion":"6.10.2","description":"WooCommerce REST API - JavaScript Library","directories":{},"lint-staged":{"*.{js,mjs}":["eslint --fix","prettier --write","git add"]},"_nodeVersion":"10.15.2","dependencies":{"axios":"^0.19.0","url-parse":"^1.4.7","oauth-1.0a":"^2.2.6","create-hmac":"^1.1.7"},"_hasShrinkwrap":false,"devDependencies":{"jest":"24.8.0","nock":"10.0.6","husky":"3.0.2","eslint":"6.1.0","del-cli":"2.0.0","prettier":"1.18.2","@babel/cli":"7.5.5","babel-jest":"24.8.0","@babel/core":"7.5.5","lint-staged":"9.2.1","@babel/preset-env":"7.5.5","eslint-plugin-jest":"22.14.0","eslint-plugin-node":"9.1.0","eslint-plugin-import":"2.18.2","eslint-plugin-promise":"4.2.1","eslint-config-prettier":"6.0.0","eslint-config-standard":"13.0.1","eslint-plugin-prettier":"3.1.0","eslint-plugin-standard":"4.0.0","@babel/plugin-transform-modules-commonjs":"7.5.0"},"_npmOperationalInternal":{"tmp":"tmp/woocommerce-rest-api_0.0.1_1564431471522_0.14851859953920288","host":"s3://npm-registry-packages"}},"1.0.0":{"name":"@woocommerce/woocommerce-rest-api","version":"1.0.0","keywords":["wordpress","woocommerce","rest","promise","node"],"author":{"name":"Automattic"},"license":"MIT","_id":"@woocommerce/woocommerce-rest-api@1.0.0","maintainers":[{"name":"albertjuhe","email":"contact@albertjuhe.com"},{"name":"claudiosanches","email":"contato@claudiosanches.com"},{"name":"coderkevin","email":"kevin@redfenix.com"},{"name":"mikejolley","email":"mikejolley86@gmail.com"},{"name":"psealock","email":"psealock@gmail.com"},{"name":"ryelle","email":"kelly.dwan@gmail.com"},{"name":"timmyc","email":"timmydcrawford@gmail.com"}],"homepage":"https://github.com/woocommerce/woocommerce-rest-api-js-lib","bugs":{"url":"https://github.com/woocommerce/woocommerce-rest-api-js/issues"},"dist":{"shasum":"b377900adc8f978078b53b45016e961aaa5a3a7f","tarball":"https://registry.npmjs.org/@woocommerce/woocommerce-rest-api/-/woocommerce-rest-api-1.0.0.tgz","fileCount":6,"integrity":"sha512-UGVd+lDM05COhp8pu6oJvXRIQ7BxZr2sauWzFOKIleVI1J+dbxGGup3UbQFCC1fRfivg/7tfZLXjVZ5W4sPP3g==","signatures":[{"sig":"MEUCIQC452ielY0fKIMDkyOPPA7BrX6Vhq5PwOlhEQO5Z/+ucwIgdzPTZ/IoeX2EecTYorv7afqvPx5GNrVHQXAj+tTprIk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28204,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdP1sfCRA9TVsSAnZWagAAQpEP/in7RisL4/RGp2YZZ7//\nEbcM+jB8Y5U5zyxY18grAWfh22EegYm3XKw8UIlWVoFt52TPzqoaaQH15nsy\nBSOleCtS57/BtX62v7OnnPZw+xPtb1skjKr2v1GUm4vkMJGX6Dw/iIMJlpHC\nLiFFrD/3grOYtlZLOmsVLBrderYiuRV3/HE1pPVQK6uU/8tGMuVfpu9Rwk87\nk6MUuL3osou9jo0grPoVWsPUNe4NXdHPAdxHF4/fQKx2ewAiRGnsvKV6dsJP\nlzfJAkfB7YSrbEQM/E85n/cPoed7ZLqsPNGi5r12vz4ejy5uq80HhsBvOVPL\nYeUdIwBPJ7HpKKlnJ7Ipz1tfAG+agpCBH7c8FF5EccP8Z6gh1Z4ltjG3O/mV\nOUq3zpvf0j+TaGJnEKn2Uerev6yZcO5Mwp4erOArcr/pBg8H8/Ztw4JC8DmN\n7qi9rY9HbJ4/Ro7z3Me3hrGFF3yxi4fkKJysp5SFHSyM8Z0yIUd8ZoBLuVZI\n6o8B+Qnv7XDocvXScgc89Tas7pLv8dyP6kgD8AZQD8qha39mN+oIBGnkdlfu\n71yhstxUbgA9pPcvt3yIwKS8xKLQWzDAYtRv3AGBdLuVy+rT0UDNLc6inb6O\nWpXEQr4VApqc39Zp2cUU11dQEpH65QjnQs9F9HTEQq0YQtdq7Jeiu+YP6mof\nZMo9\r\n=xOuw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index","husky":{"hooks":{"pre-commit":"lint-staged"}},"engines":{"node":">=8.0.0"},"gitHead":"7e27244a2b622551a005b58cfaa715a5d406e6c6","scripts":{"lint":"eslint *.mjs","test":"jest","build":"del index.js && babel index.mjs --out-dir .","format":"prettier --write \"*.mjs\" \"test.js\"","prepare":"npm run build","version":"npm run format && git add -A","preversion":"npm run lint","postversion":"git push && git push --tags","prepublishOnly":"npm test && npm run lint"},"_npmUser":{"name":"claudiosanches","email":"contato@claudiosanches.com"},"repository":{"url":"git+https://github.com/woocommerce/woocommerce-rest-api-js.git","type":"git"},"_npmVersion":"6.10.2","description":"WooCommerce REST API - JavaScript Library","directories":{},"lint-staged":{"*.{js,mjs}":["eslint --fix","prettier --write","git add"]},"_nodeVersion":"10.15.2","dependencies":{"axios":"^0.19.0","url-parse":"^1.4.7","oauth-1.0a":"^2.2.6","create-hmac":"^1.1.7"},"_hasShrinkwrap":false,"devDependencies":{"jest":"24.8.0","nock":"10.0.6","husky":"3.0.2","eslint":"6.1.0","del-cli":"2.0.0","prettier":"1.18.2","@babel/cli":"7.5.5","babel-jest":"24.8.0","@babel/core":"7.5.5","lint-staged":"9.2.1","@babel/preset-env":"7.5.5","eslint-plugin-jest":"22.14.0","eslint-plugin-node":"9.1.0","eslint-plugin-import":"2.18.2","eslint-plugin-promise":"4.2.1","eslint-config-prettier":"6.0.0","eslint-config-standard":"13.0.1","eslint-plugin-prettier":"3.1.0","eslint-plugin-standard":"4.0.0","@babel/plugin-transform-modules-commonjs":"7.5.0"},"_npmOperationalInternal":{"tmp":"tmp/woocommerce-rest-api_1.0.0_1564433182786_0.2230015018830036","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@woocommerce/woocommerce-rest-api","version":"1.0.1","keywords":["wordpress","woocommerce","rest","promise","node"],"author":{"name":"Automattic"},"license":"MIT","_id":"@woocommerce/woocommerce-rest-api@1.0.1","maintainers":[{"name":"albertjuhe","email":"contact@albertjuhe.com"},{"name":"claudiosanches","email":"contato@claudiosanches.com"},{"name":"coderkevin","email":"kevin@redfenix.com"},{"name":"mikejolley","email":"mikejolley86@gmail.com"},{"name":"psealock","email":"psealock@gmail.com"},{"name":"ryelle","email":"kelly.dwan@gmail.com"},{"name":"timmyc","email":"timmydcrawford@gmail.com"}],"homepage":"https://github.com/woocommerce/woocommerce-rest-api-js-lib","bugs":{"url":"https://github.com/woocommerce/woocommerce-rest-api-js/issues"},"dist":{"shasum":"112b998e8e3758203a71d5e3e0b24efcb1cff842","tarball":"https://registry.npmjs.org/@woocommerce/woocommerce-rest-api/-/woocommerce-rest-api-1.0.1.tgz","fileCount":6,"integrity":"sha512-YBk3EEYE0zax/egx6Rhpbu6hcCFyZpYQrjH9JO4NUGU3n3T0W9Edn7oAUbjL/c7Oezcg+UaQluCaKjY/B3zwxg==","signatures":[{"sig":"MEUCIQCLzAcbl6iPPU6IEXmmv1EDeIdXK3e/2cJDwDQ6LI0MxQIgW2reRBTiMVPYQB4ZZ1qFdeNA81RrMQXrpOil4zZ8ReY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28030,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdRI4VCRA9TVsSAnZWagAAZswP/09Z15zbP3vCQSBesmmh\nCFw/dlnE/oihWcbCqLZJ4FFLSuov9OSXC0nibodMahvmHKVrTWQP7oUoD9MQ\nTdxKUyWCqcMcDtbOgxVzld0C21u9QnRlTsy/MWAxi5HfBNbWEBteOHzoHUas\nfKbZ/W1xxtj/1IG3glGjsBVb9aV0xRYwVm5brFSCkGJ77COfb4CLhgsHl+KG\nTIxeKt0xs6X5h325sF/AjCk+OYA5w5mHBFXxx8g/Rn8EswAtpmo/IvvPlfin\n/q8ApSJFMrGWnXa75qgy5SrsnuZdB9TF2/KIcSNsunjdW6A5uYyoJfMboJco\n694XZMg5tWynsiKTTr7EU1YfIIw3z+y1ArS1o4wTG3pX5s7qhqtc1zshFPLb\nt3cAp0NqynJMuz0JVwNXcRFZYaFOACWGwWnLRXmvncrjXig6kc+jxeYQZYWK\nGqoJ0CYgYi61OWIa0xxxEzIPqZLvP4TPcg1VtM2+nXrPl1honTwXnRMa7wMe\nGJJSgcn3Jrk7lj4z3oUWIUG9R7vEMz3c+cWJI5IOoidGHuCHcE/gudRYcAZ9\nooxBPaICz9EobDOSX89qRg12bHYudnH7vM9R9RCzim7tXWWsL0ASldOz36am\nlU6uVKaPwj2Fc61qXMulICxt7MARS3tBKc5DHaUGu0wPu3AubL8g9uj0NjTR\nDLRU\r\n=eCFq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index","husky":{"hooks":{"pre-commit":"lint-staged"}},"engines":{"node":">=8.0.0"},"gitHead":"2a80caa317263889b45e302516cda14f981c1b27","scripts":{"lint":"eslint *.mjs","test":"jest","build":"del index.js && babel index.mjs --out-dir .","format":"prettier --write \"*.mjs\" \"test.js\"","prepare":"npm run build","version":"npm run format && git add -A","preversion":"npm run lint","postversion":"git push && git push --tags","prepublishOnly":"npm test && npm run lint"},"_npmUser":{"name":"claudiosanches","email":"contato@claudiosanches.com"},"repository":{"url":"git+https://github.com/woocommerce/woocommerce-rest-api-js.git","type":"git"},"_npmVersion":"6.10.2","description":"WooCommerce REST API - JavaScript Library","directories":{},"lint-staged":{"*.{js,mjs}":["eslint --fix","prettier --write","git add"]},"_nodeVersion":"10.15.2","dependencies":{"axios":"^0.19.0","url-parse":"^1.4.7","oauth-1.0a":"^2.2.6","create-hmac":"^1.1.7"},"_hasShrinkwrap":false,"devDependencies":{"jest":"24.8.0","nock":"10.0.6","husky":"3.0.2","eslint":"6.1.0","del-cli":"2.0.0","prettier":"1.18.2","@babel/cli":"7.5.5","babel-jest":"24.8.0","@babel/core":"7.5.5","lint-staged":"9.2.1","@babel/preset-env":"7.5.5","eslint-plugin-jest":"22.14.1","eslint-plugin-node":"9.1.0","eslint-plugin-import":"2.18.2","eslint-plugin-promise":"4.2.1","eslint-config-prettier":"6.0.0","eslint-config-standard":"13.0.1","eslint-plugin-prettier":"3.1.0","eslint-plugin-standard":"4.0.0","@babel/plugin-transform-modules-commonjs":"7.5.0"},"_npmOperationalInternal":{"tmp":"tmp/woocommerce-rest-api_1.0.1_1564773908410_0.0659675730533249","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@woocommerce/woocommerce-rest-api","version":"1.0.2","keywords":["wordpress","woocommerce","rest","promise","node"],"author":{"name":"Automattic"},"license":"MIT","_id":"@woocommerce/woocommerce-rest-api@1.0.2","maintainers":[{"name":"mikejolley","email":"mikejolley86@gmail.com"},{"name":"albertjuhe","email":"contact@albertjuhe.com"},{"name":"nerrad","email":"darren@roughsmootheng.in"},{"name":"obliviousharmony","email":"obliviousharmony@gmail.com"},{"name":"louwie17","email":"lourensschep@gmail.com"},{"name":"joshuatf","email":"joshuatf@gmail.com"},{"name":"chihsuan","email":"chihsuan.tw@gmail.com"},{"name":"~woocommerce","email":"atlas@matticspace.com"},{"name":"zhongruige","email":"greg.bell@automattic.com"},{"name":"opr","email":"thomas@thomasroberts.dev"}],"homepage":"https://github.com/woocommerce/woocommerce-rest-api-js-lib","bugs":{"url":"https://github.com/woocommerce/woocommerce-rest-api-js-lib/issues"},"dist":{"shasum":"c68adf2e54e612683e651047a997fa3df1e55155","tarball":"https://registry.npmjs.org/@woocommerce/woocommerce-rest-api/-/woocommerce-rest-api-1.0.2.tgz","fileCount":6,"integrity":"sha512-G+0VwM0MINF83KnT7Rg/htm9EEYADWvDPT/UWEJdZ0de1vXvsPrr4M1ksKaxgKHO8qIJViRrIHCtrui2JoVA+Q==","signatures":[{"sig":"MEQCICdrvc1p7A8sczrGmKswVRVRBngsaYWICFZqviIbc8FQAiBL8uNtuqIElPklZo9pILDpwSzzL+cdokvPmqYuZB2M6g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":32113},"main":"index","husky":{"hooks":{"pre-commit":"lint-staged"}},"types":"index.d.ts","engines":{"node":">=8.0.0"},"gitHead":"a40c9f3e55b42623df654050852d63992cc0104f","scripts":{"lint":"eslint *.mjs","test":"jest","build":"del index.js && babel index.mjs --out-dir .","format":"prettier --write \"*.mjs\" \"test.js\"","prepare":"npm run build","version":"npm run format && git add -A","preversion":"npm run lint","postversion":"git push && git push --tags","prepublishOnly":"npm test && npm run lint"},"_npmUser":{"name":"~woocommerce","actor":{"name":"~woocommerce","type":"user","email":"atlas@matticspace.com"},"email":"atlas@matticspace.com"},"repository":{"url":"git+https://github.com/woocommerce/woocommerce-rest-api-js-lib.git","type":"git"},"_npmVersion":"10.8.2","description":"WooCommerce REST API - JavaScript Library","directories":{},"lint-staged":{"*.{js,mjs}":["eslint --fix","prettier --write","git add"]},"_nodeVersion":"20.18.1","dependencies":{"axios":"^1.6.8","url-parse":"^1.4.7","oauth-1.0a":"^2.2.6","create-hmac":"^1.1.7"},"_hasShrinkwrap":false,"devDependencies":{"jest":"24.9.0","nock":"11.3.5","husky":"3.0.5","eslint":"6.4.0","del-cli":"3.0.0","prettier":"1.18.2","@babel/cli":"7.6.0","babel-jest":"24.9.0","@babel/core":"7.6.0","lint-staged":"9.3.0","@babel/preset-env":"7.6.0","eslint-plugin-jest":"22.17.0","eslint-plugin-node":"10.0.0","eslint-plugin-import":"2.18.2","eslint-plugin-promise":"4.2.1","eslint-config-prettier":"6.3.0","eslint-config-standard":"14.1.0","eslint-plugin-prettier":"3.1.1","eslint-plugin-standard":"4.0.1","@babel/plugin-transform-modules-commonjs":"7.6.0"},"_npmOperationalInternal":{"tmp":"tmp/woocommerce-rest-api_1.0.2_1752156796734_0.4297537000617755","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2019-07-29T20:17:51.352Z","modified":"2026-06-17T14:30:10.146Z","0.0.1":"2019-07-29T20:17:51.670Z","1.0.0":"2019-07-29T20:46:22.947Z","1.0.1":"2019-08-02T19:25:08.561Z","1.0.2":"2025-07-10T14:13:16.902Z"},"bugs":{"url":"https://github.com/woocommerce/woocommerce-rest-api-js-lib/issues"},"author":{"name":"Automattic"},"license":"MIT","homepage":"https://github.com/woocommerce/woocommerce-rest-api-js-lib","keywords":["wordpress","woocommerce","rest","promise","node"],"repository":{"url":"git+https://github.com/woocommerce/woocommerce-rest-api-js-lib.git","type":"git"},"description":"WooCommerce REST API - JavaScript Library","maintainers":[{"email":"mikejolley86@gmail.com","name":"mikejolley"},{"email":"contact@albertjuhe.com","name":"albertjuhe"},{"email":"darren@roughsmootheng.in","name":"nerrad"},{"email":"lourensschep@gmail.com","name":"louwie17"},{"email":"chihsuan.tw@gmail.com","name":"chihsuan"},{"email":"heart-of-gold@matticspace.com","name":"~woocommerce"},{"email":"greg.bell@automattic.com","name":"zhongruige"},{"email":"thomas@thomasroberts.dev","name":"opr"},{"email":"public@brandonkraft.com","name":"kraftbj"}],"readme":"# WooCommerce REST API - JavaScript Library\n\nNew JavaScript library for WooCommerce REST API, supports CommonJS (CJS) and Embedded System Module (ESM).\n\nRequests are made with [Axios library](https://github.com/axios/axios) with [support to promises](https://github.com/axios/axios#promises).\n\n[![npm version](https://img.shields.io/npm/v/@woocommerce/woocommerce-rest-api.svg)](https://www.npmjs.com/package/@woocommerce/woocommerce-rest-api)\n\n## Installation\n\n```\nnpm install --save @woocommerce/woocommerce-rest-api\n```\n\n## Getting started\n\nGenerate API credentials (Consumer Key & Consumer Secret) following this instructions \n.\n\nCheck out the WooCommerce API endpoints and data that can be manipulated in .\n\n## Setup\n\n### ESM example:\n\n```js\nimport WooCommerceRestApi from \"@woocommerce/woocommerce-rest-api\";\n\nconst api = new WooCommerceRestApi({\n url: \"http://example.com\",\n consumerKey: \"ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n consumerSecret: \"cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n version: \"wc/v3\"\n});\n```\n\n### CJS example:\n\n```js\nconst WooCommerceRestApi = require(\"@woocommerce/woocommerce-rest-api\").default;\n\nconst api = new WooCommerceRestApi({\n url: \"http://example.com\",\n consumerKey: \"ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n consumerSecret: \"cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n version: \"wc/v3\"\n});\n```\n\n### Options\n\n| Option | Type | Required | Description |\n|-------------------|-----------|----------|---------------------------------------------------------------------------------------------------------------------|\n| `url` | `String` | yes | Your Store URL, example: http://woo.dev/ |\n| `consumerKey` | `String` | yes | Your API consumer key |\n| `consumerSecret` | `String` | yes | Your API consumer secret |\n| `wpAPIPrefix` | `String` | no | Custom WP REST API URL prefix, used to support custom prefixes created with the `rest_url_prefix` filter |\n| `version` | `String` | no | API version, default is `v3` |\n| `encoding` | `String` | no | Encoding, default is 'utf-8' |\n| `queryStringAuth` | `Bool` | no | When `true` and using under HTTPS force Basic Authentication as query string, default is `false` |\n| `port` | `string` | no | Provide support for URLs with ports, eg: `8080` |\n| `timeout` | `Integer` | no | Define the request timeout |\n| `axiosConfig` | `Object` | no | Define the custom [Axios config](https://github.com/axios/axios#request-config), also override this library options |\n\n## Methods\n\n### GET\n\n- `.get(endpoint)`\n- `.get(endpoint, params)`\n\n| Params | Type | Description |\n|------------|----------|---------------------------------------------------------------|\n| `endpoint` | `String` | WooCommerce API endpoint, example: `customers` or `orders/12` |\n| `params` | `Object` | Query strings params, example: `{ per_page: 20 }` |\n\n### POST\n\n- `.post(endpoint, data)`\n- `.post(endpoint, data, params)`\n\n| Params | Type | Description |\n|------------|----------|-------------------------------------------------------------|\n| `endpoint` | `String` | WooCommerce API endpoint, example: `customers` or `orders` |\n| `data` | `Object` | JS object to be converted into JSON and sent in the request |\n| `params` | `Object` | Query strings params |\n\n### PUT\n\n- `.put(endpoint, data)`\n- `.put(endpoint, data, params)`\n\n| Params | Type | Description |\n|------------|----------|-------------------------------------------------------------------|\n| `endpoint` | `String` | WooCommerce API endpoint, example: `customers/1` or `orders/1234` |\n| `data` | `Object` | JS object to be converted into JSON and sent in the request |\n| `params` | `Object` | Query strings params |\n\n### DELETE\n\n- `.delete(endpoint)`\n- `.delete(endpoint, params)`\n\n| Params | Type | Description |\n|------------|----------|-----------------------------------------------------------------|\n| `endpoint` | `String` | WooCommerce API endpoint, example: `customers/2` or `orders/12` |\n| `params` | `Object` | Query strings params, example: `{ force: true }` |\n\n### OPTIONS\n\n- `.options(endpoint)`\n- `.options(endpoint, params)`\n\n| Params | Type | Description |\n|------------|----------|-----------------------------------------------------------------|\n| `endpoint` | `String` | WooCommerce API endpoint, example: `customers/2` or `orders/12` |\n| `params` | `Object` | Query strings params |\n\n## Example of use\n\n```js\n// import WooCommerceRestApi from \"@woocommerce/woocommerce-rest-api\";\nconst WooCommerceRestApi = require(\"@woocommerce/woocommerce-rest-api\").default;\n\nconst api = new WooCommerceRestApi({\n url: \"http://example.com\",\n consumerKey: \"ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n consumerSecret: \"cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n version: \"wc/v3\"\n});\n\n// List products\napi.get(\"products\", {\n per_page: 20, // 20 products per page\n})\n .then((response) => {\n // Successful request\n console.log(\"Response Status:\", response.status);\n console.log(\"Response Headers:\", response.headers);\n console.log(\"Response Data:\", response.data);\n console.log(\"Total of pages:\", response.headers['x-wp-totalpages']);\n console.log(\"Total of items:\", response.headers['x-wp-total']);\n })\n .catch((error) => {\n // Invalid request, for 4xx and 5xx statuses\n console.log(\"Response Status:\", error.response.status);\n console.log(\"Response Headers:\", error.response.headers);\n console.log(\"Response Data:\", error.response.data);\n })\n .finally(() => {\n // Always executed.\n });\n\n// Create a product\napi.post(\"products\", {\n name: \"Premium Quality\", // See more in https://woocommerce.github.io/woocommerce-rest-api-docs/#product-properties\n type: \"simple\",\n regular_price: \"21.99\",\n})\n .then((response) => {\n // Successful request\n console.log(\"Response Status:\", response.status);\n console.log(\"Response Headers:\", response.headers);\n console.log(\"Response Data:\", response.data);\n })\n .catch((error) => {\n // Invalid request, for 4xx and 5xx statuses\n console.log(\"Response Status:\", error.response.status);\n console.log(\"Response Headers:\", error.response.headers);\n console.log(\"Response Data:\", error.response.data);\n })\n .finally(() => {\n // Always executed.\n });\n\n// Edit a product\napi.put(\"products/1\", {\n sale_price: \"11.99\", // See more in https://woocommerce.github.io/woocommerce-rest-api-docs/#product-properties\n})\n .then((response) => {\n // Successful request\n console.log(\"Response Status:\", response.status);\n console.log(\"Response Headers:\", response.headers);\n console.log(\"Response Data:\", response.data);\n })\n .catch((error) => {\n // Invalid request, for 4xx and 5xx statuses\n console.log(\"Response Status:\", error.response.status);\n console.log(\"Response Headers:\", error.response.headers);\n console.log(\"Response Data:\", error.response.data);\n })\n .finally(() => {\n // Always executed.\n });\n\n// Delete a product\napi.delete(\"products/1\", {\n force: true, // Forces to delete instead of move to the Trash\n})\n .then((response) => {\n // Successful request\n console.log(\"Response Status:\", response.status);\n console.log(\"Response Headers:\", response.headers);\n console.log(\"Response Data:\", response.data);\n })\n .catch((error) => {\n // Invalid request, for 4xx and 5xx statuses\n console.log(\"Response Status:\", error.response.status);\n console.log(\"Response Headers:\", error.response.headers);\n console.log(\"Response Data:\", error.response.data);\n })\n .finally(() => {\n // Always executed.\n });\n```\n\n## Changelog\n\n[See changelog for details](https://github.com/woocommerce/woocommerce-rest-api-js-lib/blob/master/CHANGELOG.md)\n","readmeFilename":"README.md"}