{"_id":"@agnostack/shipstation-request","_rev":"2-d49205cea94250a66512db8617ecc62a","name":"@agnostack/shipstation-request","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@agnostack/shipstation-request","version":"1.0.0","author":{"name":"Rob Bowers","email":"rob@uniquelyparticular.com","url":"https://uniquelyparticular.com"},"owner":"agnoStack","description":"Please contact agnoStack via info@agnostack.com for any questions","homepage":"https://github.com/agnostack/shipstation-request#readme","repository":{"type":"git","url":"git+https://github.com/agnostack/shipstation-request.git"},"keywords":["shipstation","shipping","ecommerce","api","node","typescript","javascript","agnostack","particular","particular."],"license":"MIT","main":"dist/index.js","typings":"dist/index.d.ts","scripts":{"build":"yarn clean && tsc -d","clean":"rimraf dist","clean-install":"yarn clean; yarn install --force","test":"jest --passWithNoTests","semantic-release":"semantic-release"},"husky":{"hooks":{"pre-commit":"pretty-quick --staged"}},"dependencies":{"cross-fetch":"3.0.4","js-base64":"2.5.1"},"devDependencies":{"@types/fetch-mock":"7.3.2","@types/jest":"24.0.24","chai":"4.2.0","fetch-everywhere":"1.0.5","fetch-mock":"7.7.3","husky":"2.7.0","jest":"24.9.0","prettier":"1.19.1","pretty-quick":"1.11.1","rimraf":"2.7.1","semantic-release":"15.13.31","ts-jest":"24.2.0","typescript":"3.7.3"},"publishConfig":{"access":"public"},"gitHead":"0a45e5ec5c6bfa54303e8c75a69bf28340366e93","bugs":{"url":"https://github.com/agnostack/shipstation-request/issues"},"_id":"@agnostack/shipstation-request@1.0.0","_nodeVersion":"12.14.0","_npmVersion":"6.13.2","dist":{"integrity":"sha512-i/Xw3AIxovzKfIvK9ZbrciDywYIE1ArJXTrpgnWXi5grhuz8wkrie8LZAT20lr+5/OG9QaoX5AVfivjGpYA+GA==","shasum":"81a601225eac25315b9b59d14f7ec081f586fe01","tarball":"https://registry.npmjs.org/@agnostack/shipstation-request/-/shipstation-request-1.0.0.tgz","fileCount":18,"unpackedSize":18510,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd/SuRCRA9TVsSAnZWagAA1UwP/3hVTS4O7BLkwA6185K5\njVRL6RDjIzCcqlC8wrz/cD7+lshp+Y7yH9X/3cdcrAuXNxrltACT7XCHpv/3\n9cctmny5bJnxfpKf/Z4IOM3vDLr+9DroXNkitZ9Q6S5iy3/SDQz77mTN0H3J\ni+4Alk2+UlClhflYrrYSLt2SXRMp5kW1ABpFuZs8STBSYqWPhh+wD9H7gU/T\nmvQ+ZnzsLFVSx6hSURhJu5oMUVpJIW8IFdt0M20wbEz81BA/D1L28OvZa9og\nQa6sqNbYn+9ojw79bHqHvbMJL0FJX3ypPYR3unRgVBVmhkVG+1M6T6i90S9C\n2g9pt8NJ8/d/3PNj9l6X5bb3pAsJXzDIlZT2wpIRjt9zNxLGTbM2S/swuvDw\n0hetgWaMT654xLaVrb2IBoIWDniZdVV4fpAQEsREY19YRpQAZJxTUJAx5Qsi\nt7Pu05WlME8tcSv6gdd4LH+/sbY6J/ayoyWQMt0HTJjLSYtVdfXLCz9iVCsH\n9gMcvl677J3F+geYTi5oaLFbzzYFATQ5aHceRg+grr9AqWpBPAiMX90wnlAw\nYKfDOcONGJSYiDa5Cz1MqqJwooqz7e5VqyAriAYwIaieI+PkeurKnWiTIjBJ\n4hRxERdalWHgVQbCPxefGCVNkg4GxsyYeXVSGi01zD9wI54l1GEJE6e45uID\nxcvU\r\n=Slse\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBY87utA26PTrjmfP4sSUtgEKaJ7pO1jgegOcXsEdZ3lAiAMe4Etn2q3hPNeKdgjSJKLYi/agI2I5UMoiLwHUP/CoA=="}]},"maintainers":[{"name":"agrohs","email":"adam@uniquelyparticular.com"}],"_npmUser":{"name":"agrohs","email":"adam@uniquelyparticular.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/shipstation-request_1.0.0_1576872848896_0.7054334068168455"},"_hasShrinkwrap":false},"1.0.1":{"name":"@agnostack/shipstation-request","version":"1.0.1","author":{"name":"Rob Bowers","email":"rob@uniquelyparticular.com","url":"https://uniquelyparticular.com"},"owner":"agnoStack","description":"Please contact agnoStack via info@agnostack.com for any questions","homepage":"https://github.com/agnostack/shipstation-request#readme","repository":{"type":"git","url":"git+https://github.com/agnostack/shipstation-request.git"},"keywords":["shipstation","shipping","ecommerce","api","node","typescript","javascript","agnostack","particular","particular."],"license":"MIT","main":"dist/index.js","typings":"dist/index.d.ts","scripts":{"build":"yarn clean && tsc -d","clean":"rimraf dist","clean-install":"yarn clean; yarn install --force","test":"jest --passWithNoTests","semantic-release":"semantic-release"},"husky":{"hooks":{"pre-commit":"pretty-quick --staged"}},"dependencies":{"cross-fetch":"3.0.4","js-base64":"2.5.1"},"devDependencies":{"@types/fetch-mock":"7.3.2","@types/jest":"24.0.25","chai":"4.2.0","fetch-everywhere":"1.0.5","fetch-mock":"7.7.3","husky":"2.7.0","jest":"24.9.0","prettier":"1.19.1","pretty-quick":"1.11.1","rimraf":"2.7.1","semantic-release":"15.14.0","ts-jest":"24.2.0","typescript":"3.7.4"},"publishConfig":{"access":"public"},"gitHead":"f28a0c8195955430c77e444055acd9d003db3700","bugs":{"url":"https://github.com/agnostack/shipstation-request/issues"},"_id":"@agnostack/shipstation-request@1.0.1","_nodeVersion":"10.16.3","_npmVersion":"6.13.2","dist":{"integrity":"sha512-vVh46hiVhNkHuDa6DB4D9orbUJpK8X76GOsjyksYeUBRhC/jgoAQEUlzAPeRKv2pv8x/aOi4Bm59K+5Ce7/FSQ==","shasum":"060a228e0af738090758a4f5c3f9cf690316b766","tarball":"https://registry.npmjs.org/@agnostack/shipstation-request/-/shipstation-request-1.0.1.tgz","fileCount":18,"unpackedSize":18509,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeBY+9CRA9TVsSAnZWagAAp7UP/RmZUWM2npqLR3MHQKzH\nwdl7p/Mx6N/6JC9wctrkhiDJ/4nfYutC4cVXJUy7stwPlmSXBOPeX8m5n7ea\nvYNsnqCc1QgxtFTlSamEyVffUdEFJqp5en8LB7h6SN4cVJvZGMP63f4sK82c\nhrtBy+amYMYed6pECQm5qzv7RM+Qt2hyTkKwil06kg1sB1cNlPsXkY2fq8lO\nFqz5fr+8kTRQU3S8LA2/n3s4CxzePRdOnOFxutH8ueYTeVAjRBDnFSUY69QD\n2KIwB7lUCiMm4f41Cbg/cPTSO7RFI4mdnWkmlF5kEwHXhuWOIDXusPzuGqfn\n+dHJotn1Srj2sCox+e9oLRtoAemUmv+0VRRjhEfRQ/8Mff+iAl9j3BTcb9FO\nbJS781M3AFg1z9LUdENJf3N4UTtkfMr3PceRAtDrWE0q/wIIbJEikYaKII1C\nFixm6CvODtOo5eoaWRBPgr7nJhQrJE1qrFU676DH3XlnucRjSA9EUkfrl/tR\ns2n2wn8zCtZr0zvX3jQh6fRxbjXQsWbIWr+cUuCgGZs7f5WtPYF3REpYDXBQ\nDUa4mG/4pUXA+7+hX41/kXME1/dg5LiWmAF/5J9RBItvKMDTeePZMlTnUSV1\nUuU7C0GwedDj/BrrCM+H3+gx0vYmYdgvQdCZ695tZp8Q78U3jVsT5UyeZijl\neJ5H\r\n=0NpH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGW9MtKvod4Pzl+71XSatMJOPd8a4r1TrmFPXrE5rFbAAiBJ6PkV/BbY+NuddWoa45MM9CUrwvzLZadxGiwK10GyIg=="}]},"maintainers":[{"name":"agrohs","email":"adam@uniquelyparticular.com"}],"_npmUser":{"name":"agrohs","email":"adam@uniquelyparticular.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/shipstation-request_1.0.1_1577422781257_0.382743685553363"},"_hasShrinkwrap":false}},"time":{"created":"2019-12-20T20:14:08.675Z","1.0.0":"2019-12-20T20:14:09.061Z","modified":"2022-04-04T12:00:14.754Z","1.0.1":"2019-12-27T04:59:41.497Z"},"maintainers":[{"name":"agrohs","email":"adam@uniquelyparticular.com"}],"description":"Please contact agnoStack via info@agnostack.com for any questions","homepage":"https://github.com/agnostack/shipstation-request#readme","keywords":["shipstation","shipping","ecommerce","api","node","typescript","javascript","agnostack","particular","particular."],"repository":{"type":"git","url":"git+https://github.com/agnostack/shipstation-request.git"},"author":{"name":"Rob Bowers","email":"rob@uniquelyparticular.com","url":"https://uniquelyparticular.com"},"bugs":{"url":"https://github.com/agnostack/shipstation-request/issues"},"license":"MIT","readme":"# @agnostack/shipstation-request\n\n[![npm version](https://img.shields.io/npm/v/@agnostack/shipstation-request.svg)](https://www.npmjs.com/package/@agnostack/shipstation-request) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![CircleCI](https://img.shields.io/circleci/project/github/agnostack/shipstation-request.svg?label=circleci)](https://circleci.com/gh/agnostack/shipstation-request)\n\n> 🎮 Minimal [ShipStation](https://www.shipstation.com/) API request library for Node\n\n## Installation\n\n```bash\nyarn add @agnostack/shipstation-request  # npm install @agnostack/shipstation-request\n```\n\n## Quickstart (OAuth)\n\n```js\nconst { createClient } = require('@agnostack/shipstation-request');\n// import { createClient } from '@agnostack/shipstation-request'\n\n// NOTE: You'll need to generate an API Key and API Secret under\n//   Account Settings > Account > API Settings > Generate New API Keys\nconst shipstation = new createClient({\n  public_key: '...', // Shipstation API Key\n  secret_key: '...' // Shipstation API Secret\n});\n\nshipstation\n  .get('/carriers')\n  .then(console.log)\n  .catch(console.error);\n\nshipstation\n  .post('/shipments/getrates', {\n    carrierCode: 'fedex',\n    serviceCode: null,\n    packageCode: null,\n    fromPostalCode: '78703',\n    toState: 'DC',\n    toCountry: 'US',\n    toPostalCode: '20500',\n    toCity: 'Washington',\n    weight: {\n      value: 3,\n      units: 'ounces'\n    },\n    dimensions: {\n      units: 'inches',\n      length: 7,\n      width: 5,\n      height: 6\n    },\n    confirmation: 'delivery',\n    residential: false\n  })\n  .then(console.log)\n  .catch(console.error);\n\nshipstation\n  .get(`/orders`)\n  .then(console.log)\n  .catch(console.error);\n```\n\n## Kitchen sink\n\n```js\nconst shipstation = new createClient({\n  public_key: '...',\n  secret_key: '...',\n  application: '...',\n  headers: {\n    // ...\n  }\n});\n```\n\n## Custom headers per request\n\nThe API provides you the ability to send various request headers that change the way data is stored or retrieved.\n\nBy default this library will encode all data as JSON, however you can customise this by setting your own `Content-Type` header as an additional argument to `get`, `patch`, `post`, `put` and `delete`.\n\n**Note**: If you add the `Content-Type` custom header to `patch`, `post`, `put` or `delete` you will need to encode `data` yourself.\n\n```js\nconst shipstation = new createClient({\n  public_key: '...',\n  secret_key: '...'\n});\n\nconst headers = {\n  'X-My-Header': 'custom'\n};\n\nshipstation\n  .get('/carriers', headers)\n  .then(console.log)\n  .catch(console.error);\n```\n\n_Contact [Adam Grohs](https://www.linkedin.com/in/adamgrohs/) @ [agnoStack](https://agnostack.com/) for any questions._\n","readmeFilename":"README.md"}