{"id":28338860,"url":"https://github.com/uniquelyparticular/shipengine-request","last_synced_at":"2025-10-08T12:50:28.495Z","repository":{"id":34645134,"uuid":"180855508","full_name":"uniquelyparticular/shipengine-request","owner":"uniquelyparticular","description":"A Particularly minimal ShipEngine API request library for Node.","archived":false,"fork":false,"pushed_at":"2025-09-16T06:34:59.000Z","size":782,"stargazers_count":1,"open_issues_count":20,"forks_count":1,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-09-16T08:33:26.192Z","etag":null,"topics":["api","javascript","node","particular","shipengine","typescript"],"latest_commit_sha":null,"homepage":"https://uniquelyparticular.com","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/uniquelyparticular.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-04-11T18:36:23.000Z","updated_at":"2024-07-25T17:46:47.000Z","dependencies_parsed_at":"2023-01-15T08:30:56.196Z","dependency_job_id":"833fd32f-a431-4f8c-837b-e8fb3eab9dd2","html_url":"https://github.com/uniquelyparticular/shipengine-request","commit_stats":{"total_commits":72,"total_committers":7,"mean_commits":"10.285714285714286","dds":0.5277777777777778,"last_synced_commit":"15687b5fbf8a994dd14fb1ff5952e5a59707817f"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/uniquelyparticular/shipengine-request","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshipengine-request","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshipengine-request/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshipengine-request/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshipengine-request/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uniquelyparticular","download_url":"https://codeload.github.com/uniquelyparticular/shipengine-request/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshipengine-request/sbom","scorecard":{"id":390062,"data":{"date":"2025-08-11","repo":{"name":"github.com/uniquelyparticular/shipengine-request","commit":"15687b5fbf8a994dd14fb1ff5952e5a59707817f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"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":"Code-Review","score":0,"reason":"Found 0/11 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":"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:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"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":"Branch-Protection","score":-1,"reason":"internal error: error during GetBranch(master): error during branchesHandler.query: 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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 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":"85 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-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-2mj8-pj3j-h362","Warn: Project is vulnerable to: GHSA-gqf6-75v8-vr26","Warn: Project is vulnerable to: GHSA-v45m-2wcp-gg98","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","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-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-px4h-xg32-q955","Warn: Project is vulnerable to: GHSA-m6cx-g6qm-p2cx","Warn: Project is vulnerable to: GHSA-x8qc-rrcw-4r46","Warn: Project is vulnerable to: GHSA-4328-8hgf-7wjr","Warn: Project is vulnerable to: GHSA-93f3-23rq-pjfp","Warn: Project is vulnerable to: GHSA-jmqm-f2gx-4fjv","Warn: Project is vulnerable to: GHSA-pw54-mh39-w3hc","Warn: Project is vulnerable to: GHSA-xgh6-85xh-479p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","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","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"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-18T17:35:43.585Z","repository_id":34645134,"created_at":"2025-08-18T17:35:43.585Z","updated_at":"2025-08-18T17:35:43.585Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278948018,"owners_count":26073747,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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","javascript","node","particular","shipengine","typescript"],"created_at":"2025-05-27T00:52:16.173Z","updated_at":"2025-10-08T12:50:28.489Z","avatar_url":"https://github.com/uniquelyparticular.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @particular./shipengine-request\n\n[![npm version](https://img.shields.io/npm/v/@particular./shipengine-request.svg)](https://www.npmjs.com/package/@particular./shipengine-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/uniquelyparticular/shipengine-request.svg?label=circleci)](https://circleci.com/gh/uniquelyparticular/shipengine-request)\n![dependency status: david](https://img.shields.io/david/uniquelyparticular/shipengine-request.svg)\n\n\u003e 🎮 Minimal [ShipEngine](https://www.shipengine.com) API request library for Node\n\n## Installation\n\n```bash\nyarn add @particular./shipengine-request # npm install @particular./shipengine-request\n```\n\n## Quickstart (implicit)\n\n```js\nconst { createClient } = require('@particular./shipengine-request');\n// import { createClient } from '@particular./shipengine-request'\n\nconst shipEngine = new createClient({\n  client_secret: '...'\n});\n\nshipEngine\n  .delete('tags/:tag_name')\n  .then(console.log)\n  .catch(console.error);\n\nshipEngine\n  .get('carriers')\n  .then(console.log)\n  .catch(console.error);\n\nshipEngine\n  .patch('insurance/shipsurance/add_funds', {\n    currency: 'usd',\n    amount: 10.0\n  })\n  .then(console.log)\n  .catch(console.error);\n\nshipEngine\n  .post('rates', {\n    shipment_id: 'se-123',\n    rate_options: {\n      carrier_ids: ['se-123890']\n    }\n  })\n  .then(console.log)\n  .catch(console.error);\n\nshipEngine\n  .put('shipments/:shipment_id', {\n    validate_address: 'no_validation',\n    shipment_id: 'se-202902255',\n    carrier_id: 'se-123890',\n    service_code: 'usps_priority_mail',\n    external_shipment_id: '6801bdc2-ed1d-472f-8108-fcc3c163a172',\n    ship_date: '2019-04-11T05:00:00.000Z',\n    created_at: '2019-04-11T19:09:29.151Z',\n    modified_at: '2019-04-11T19:09:29.151Z',\n    shipment_status: 'pending',\n    ship_to: {\n      name: 'Mickey and Minnie Mouse',\n      phone: '714-781-4565',\n      company_name: 'The Walt Disney Company',\n      address_line1: '500 S BUENA VISTA ST',\n      address_line2: '',\n      city_locality: 'BURBANK',\n      state_province: 'CA',\n      postal_code: '91521-0001',\n      country_code: 'US'\n    },\n    // ...\n    insurance_provider: 'none',\n    tags: [],\n    packages: [\n      {\n        weight: {\n          value: 9.6,\n          unit: 'ounce'\n        },\n        dimensions: {\n          unit: 'inch',\n          length: 12.0,\n          width: 7.1,\n          height: 6.0\n        },\n        insured_value: {\n          currency: 'usd',\n          amount: 0.0\n        }\n      }\n    ]\n  })\n  .then(console.log)\n  .catch(console.error);\n```\n\n## Kitchen sink\n\n```js\nconst { createClient } = require('@particular./shipengine-request');\n\nconst shipEngine = new createClient({\n  client_secret: '...',\n  host: '...',\n  version: '...',\n  application: '...',\n  currency: '...',\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 { createClient } = require('@particular./shipengine-request');\n\nconst shipEngine = new createClient({\n  client_secret: '...'\n});\n\nconst headers = {\n  'X-ShipEngine-Currency': 'gbp'\n};\n\nshipEngine\n  .get('carriers', headers)\n  .then(console.log)\n  .catch(console.error);\n```\n\n_Contact [Adam Grohs](https://www.linkedin.com/in/adamgrohs/) @ [Particular.](https://uniquelyparticular.com) for any questions._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funiquelyparticular%2Fshipengine-request","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funiquelyparticular%2Fshipengine-request","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funiquelyparticular%2Fshipengine-request/lists"}