{"id":29966296,"url":"https://github.com/aligent/bigcommerce-api","last_synced_at":"2025-08-04T02:32:43.563Z","repository":{"id":284686453,"uuid":"955627675","full_name":"aligent/bigcommerce-api","owner":"aligent","description":"Fully typed BigCommerce Management API Client for Node.Js","archived":false,"fork":false,"pushed_at":"2025-07-22T23:56:24.000Z","size":1105,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-07-29T03:17:32.058Z","etag":null,"topics":["bigcommerce","nodejs","rest-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Space48/bigcommerce-api-js","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aligent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-27T00:04:22.000Z","updated_at":"2025-07-22T23:55:09.000Z","dependencies_parsed_at":"2025-05-23T05:32:09.836Z","dependency_job_id":"6512e6fb-68df-483b-88f3-1b95e533da0e","html_url":"https://github.com/aligent/bigcommerce-api","commit_stats":null,"previous_names":["tvhees/bigcommerce-api-js","tvhees/bigcommerce-api","aligent/bigcommerce-api"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/aligent/bigcommerce-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fbigcommerce-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fbigcommerce-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fbigcommerce-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fbigcommerce-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aligent","download_url":"https://codeload.github.com/aligent/bigcommerce-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fbigcommerce-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268639931,"owners_count":24282678,"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-08-04T02:00:09.867Z","response_time":79,"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":["bigcommerce","nodejs","rest-api","typescript"],"created_at":"2025-08-04T02:32:18.582Z","updated_at":"2025-08-04T02:32:43.547Z","avatar_url":"https://github.com/aligent.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aligent BigCommerce API Client\n\nA JavaScript client for BigCommerce's [Management](src/management/README.md) API with full TypeScript typings for all API endpoints.\n\n## Features\n\n- Full coverage and Typescript typing for BigCommerce's Management REST APIs\n- Easy IDE autocompeletion of endpoints, parameters and response data\n- Automatic retry of intermittent errors such as 429 and 5xx with exponential backoff\n\n## Supported environments\n\n- Node.js \u003e=18\n\n# Getting started\n\nTo get started with the JavaScript client you'll need to install it, and then follow the instructions for either the Storefront API client or the Management API client.\n\n- [Installation](#installation)\n- [Getting started with the Management API client](src/management/README.md#getting-started)\n\n## Installation\n\n### Node\n\n```sh\nnpm install @aligent/bigcommerce-api\n```\n\n## Notes on the source schemas\n\nManagement REST API schemas are taken from the BigCommerce documentation here: https://github.com/bigcommerce/docs/tree/main/reference\n\n### Undeclared REST methods\n\nREST methods not declared in a schema are by default included in openapi-typescript with a value of `never`.\n\nTo improve UX and reduce complexity at compile time these methods are removed from the built types.\n\n### Accept and Content-Type headers\n\nAlmost all requests require a value of `application/json` for these headers - the exception being methods supporting `multipart/form-data` (e.g. image uploads).\n\nFor ease of use the exported client automatically sets the appropriate headers, and the required types are instead set to optional in the exported types.\n\n### \"Empty\" response codes\n\nSome methods declare what appears to be an invalid or unnecessary additional response code with an empty object as the value for `application/json`.\n\nThese are removed from the generated Typescript types as they force users to check the response type when it should never be necessary (e.g. 201 on a GET request)\n\n### GET customers/{customerId}/metafields and customers/{customerId}/metafields/{metafieldId}\n\nThe response payloads for these are incorrectly declared in BigCommerce's documentation and schemas: https://github.com/bigcommerce/docs/issues/912\n\nThe generated types for these endpoints are currently incorrect as a result.\n\n### catalog/products/{product_id}/images and catalog/products/{product_id}/images/{imageId}\n\nThe documentation site pulls the schema for these endpoints from a different source.\n\n### Migration from @space48/bigcommerce-api\n\nThis library was built on the groundwork laid by the `@space48/bigcommerce-api` library (https://github.com/Space48/bigcommerce-api-js/).\n\nBigCommerce have changed their published schemas substantially since the last time that library was built. If you are migrating, please check [docs/CHANGED_PATHS.md](./docs/CHANGED_PATHS.md).\n\n\u003e [!WARNING]\n\u003e\n\u003e There may be other changes to query, path, and response variables. Migration may require additional changes to your code.\n\n## Versioning\n\nThis project strictly follows [Semantic Versioning](http://semver.org/).\n\nNew versions may include changes pulled from the BigCommerce source schemas. Look in [docs/changelog](./docs//changelog/) for any resulting changes to interfaces.\n\n## Support\n\nIf you have a problem with this library, please file an [issue](https://github.com/aligent/bigcommerce-api/issues/new) here on GitHub.\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md)\n\n## License\n\nMIT\n\n## Under development\n\n- [x] Easier customisation of fetch client\n- [ ] Expose the storefront API paths properly\n- [ ] Regular rebuild and publish schedule to keep up with BigCommerce API schema changes\n- [ ] Migrate generation code to Typescript\n- [x] Properly publish ESM and CJS exports\n- [ ] Audit eslint/typescript ignore comments\n- [ ] Audit type narrowing and parameter types (especially in v2)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fbigcommerce-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faligent%2Fbigcommerce-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fbigcommerce-api/lists"}