{"_id":"1pulse-woocommerce-rest-api","_rev":"1-75de32810c8edb382f1d00c326151c72","name":"1pulse-woocommerce-rest-api","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.2":{"name":"1pulse-woocommerce-rest-api","version":"1.0.2","description":"WooCommerce REST API - JavaScript Library","author":{"name":"Automattic"},"license":"MIT","keywords":["wordpress","woocommerce","rest","promise","node"],"homepage":"https://github.com/woocommerce/woocommerce-rest-api-js-lib","repository":{"type":"git","url":"git+https://github.com/woocommerce/woocommerce-rest-api-js-lib.git"},"bugs":{"url":"https://github.com/woocommerce/woocommerce-rest-api-js-lib/issues"},"main":"index","types":"index.d.ts","dependencies":{"axios":"^0.19.0","create-hmac":"^1.1.7","oauth-1.0a":"^2.2.6","url-parse":"^1.4.7"},"devDependencies":{"@babel/cli":"7.6.0","@babel/core":"7.6.0","@babel/plugin-transform-modules-commonjs":"7.6.0","@babel/preset-env":"7.6.0","babel-jest":"24.9.0","del-cli":"3.0.0","eslint":"6.4.0","eslint-config-prettier":"6.3.0","eslint-config-standard":"14.1.0","eslint-plugin-import":"2.18.2","eslint-plugin-jest":"22.17.0","eslint-plugin-node":"10.0.0","eslint-plugin-prettier":"3.1.1","eslint-plugin-promise":"4.2.1","eslint-plugin-standard":"4.0.1","husky":"3.0.5","jest":"24.9.0","lint-staged":"9.3.0","nock":"11.3.5","prettier":"1.18.2"},"scripts":{"build":"del index.js && babel index.mjs --out-dir .","test":"jest","format":"prettier --write \"*.mjs\" \"test.js\"","lint":"eslint *.mjs","prepare":"npm run build","prepublishOnly":"npm test && npm run lint","preversion":"npm run lint","version":"npm run format && git add -A","postversion":"git push && git push --tags"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,mjs}":["eslint --fix","prettier --write","git add"]},"engines":{"node":">=8.0.0"},"gitHead":"df07b1ab6c5cc20b08d76313cbe94ac8f9de1402","_id":"1pulse-woocommerce-rest-api@1.0.2","_nodeVersion":"12.18.3","_npmVersion":"7.10.0","dist":{"integrity":"sha512-Jte9QdKE/4dW6C9BNv95qaU1MdBubMFeO9CNm2uSxPR98qMeWCrLsQtTmBcxjfqME0JYzGDk/H19YHgSfA9NPw==","shasum":"dfe94e92de56c0ac3777daf449f6c5c841cb60b0","tarball":"https://registry.npmjs.org/1pulse-woocommerce-rest-api/-/1pulse-woocommerce-rest-api-1.0.2.tgz","fileCount":7,"unpackedSize":33111,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgtRyeCRA9TVsSAnZWagAAVqsP/3iASVk1AlNykFmwi4Vt\n/2w3BmF+Ni2Jnndm0kFDEb5Y+scvvVVmIMYuq3OH9twlC6UblBvow46W8pdl\n78gPDXX9wH4y0w+kgrlyuCz09AxetWc7rxiHUxpYhwBrzQiZO6+F9bW74INK\nF2oK2zDPuEIh7k5MEwAk1BBNe+DzG+d7Fh5f8CX1XJ4Zuix03gwfqtMwoOFR\nHUo8mx/uGuWcPCqC47AZ6T97xWPHyr0ve6bKVZAwpYKdK6SYesdyEb12xsme\nAClPDWMsLFf6VIo4deQdo7ycvzsxboc92rBAQOFt44aC6GtkXtJfKSxxJ0dn\nTixwbFUq+YepfcRb/GN4KhvhlKnpbcP4wZ2OytLUBJArZns4Ow+QbNJ3TE0C\ngGUrq2Oh5diQhhMBUUpd9SxjOdMqLvlY05f7q/zwm8xFrbJ27jdwxVtdpZhq\n0FSDDnXDD4+vS58FnwxOztFFsjawsn9c2Q5wZimw/nCBpcQcOx4g6ow0re2I\nR2o+DEcB+6CMWA1hCnBGr+l4aIM45viXtgH+eaH64+61qHLuf+SMsKM+qLFu\nDe4bIaY3yqwJExE4YSjw4BAu33dy9aDN36pHXUVxYZ7fHwd8ffAwKq+DKxHE\nDiOy2gZ0W1ZYxf2pY8Aqsi4EElCVUV6S8x3Pz41wJYKV3OGEI7s/4DEqdIMx\n5BnT\r\n=gxaC\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDlbLP5TY//bQDlGmK2/oPlK46aW4BvtGWZCjdwWzGFUAIhAJYMQUTH5Kg0/X+BXjLeWymKuzvc18GJurfW0UN8Lq6y"}]},"_npmUser":{"name":"erick303","email":"erick.vdlinde@gmail.com"},"directories":{},"maintainers":[{"name":"erick303","email":"erick.vdlinde@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/1pulse-woocommerce-rest-api_1.0.2_1622482078177_0.6249099906184381"},"_hasShrinkwrap":false}},"time":{"created":"2021-05-31T17:27:58.176Z","1.0.2":"2021-05-31T17:27:58.302Z","modified":"2022-04-04T10:13:23.045Z"},"maintainers":[{"name":"erick303","email":"erick.vdlinde@gmail.com"}],"description":"WooCommerce REST API - JavaScript Library","homepage":"https://github.com/woocommerce/woocommerce-rest-api-js-lib","keywords":["wordpress","woocommerce","rest","promise","node"],"repository":{"type":"git","url":"git+https://github.com/woocommerce/woocommerce-rest-api-js-lib.git"},"author":{"name":"Automattic"},"bugs":{"url":"https://github.com/woocommerce/woocommerce-rest-api-js-lib/issues"},"license":"MIT","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[](http://travis-ci.org/woocommerce/woocommerce-rest-api-js-lib)\n[](https://david-dm.org/woocommerce/woocommerce-rest-api-js-lib)\n[](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"}