{"id":19622188,"url":"https://github.com/commercetools/commercetools-customer-export","last_synced_at":"2026-03-11T23:03:29.100Z","repository":{"id":39764017,"uuid":"52093404","full_name":"commercetools/commercetools-customer-export","owner":"commercetools","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-17T12:09:58.000Z","size":878,"stargazers_count":2,"open_issues_count":19,"forks_count":6,"subscribers_count":26,"default_branch":"master","last_synced_at":"2026-02-02T03:58:32.716Z","etag":null,"topics":["audit-import-export"],"latest_commit_sha":null,"homepage":"","language":"CoffeeScript","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/commercetools.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}},"created_at":"2016-02-19T14:33:49.000Z","updated_at":"2024-11-17T12:10:02.000Z","dependencies_parsed_at":"2024-08-26T12:24:46.013Z","dependency_job_id":"5bafd80b-dc35-4f6c-ac24-0fa3443c03e7","html_url":"https://github.com/commercetools/commercetools-customer-export","commit_stats":null,"previous_names":["sphereio/commercetools-customer-export"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/commercetools/commercetools-customer-export","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-customer-export","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-customer-export/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-customer-export/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-customer-export/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commercetools","download_url":"https://codeload.github.com/commercetools/commercetools-customer-export/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-customer-export/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30406401,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T22:36:59.286Z","status":"ssl_error","status_checked_at":"2026-03-11T22:36:57.544Z","response_time":84,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["audit-import-export"],"created_at":"2024-11-11T11:26:28.942Z","updated_at":"2026-03-11T23:03:29.084Z","avatar_url":"https://github.com/commercetools.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv style=\"background-color: yellow; color: black; padding: 10px; text-align: center; font-weight: bold;\"\u003e\n  \u003ch2\u003e🚨 Non-maintainable 🚨\u003c/h2\u003e\n  \u003cp\u003eStarting January 1, 2025, we will no longer provide maintenance or updates for the CLI ImpEx tools. After this date, this tool will no longer receive bug fixes, security patches, or new features.\u003c/p\u003e\n\u003c/div\u003e\n\n\n\u003cimg src=\"https://impex.europe-west1.gcp.commercetools.com/static/images/ct-logo.svg\" alt=\"commercetools logo\" width=\"200\"\u003e\n\n# Customer export\n\n\n[![Build Status](https://secure.travis-ci.org/mmoelli/commercetools-customer-export.png?branch=master)](http://travis-ci.org/mmoelli/commercetools-customer-export) [![NPM version](https://badge.fury.io/js/sphere-customer-export.png)](http://badge.fury.io/js/sphere-customer-export) [![Coverage Status](https://coveralls.io/repos/mmoelli/commercetools-customer-export/badge.png)](https://coveralls.io/r/mmoelli/commercetools-customer-export) [![Dependency Status](https://david-dm.org/mmoelli/commercetools-customer-export.png?theme=shields.io)](https://david-dm.org/mmoelli/commercetools-customer-export) [![devDependency Status](https://david-dm.org/mmoelli/commercetools-customer-export/dev-status.png?theme=shields.io)](https://david-dm.org/mmoelli/commercetools-customer-export#info=devDependencies)\n\nThis module allows to export customers to CSV, with SFTP support.\n\n## Getting started\n\n```bash\n$ npm install -g sphere-customer-export\n\n# output help screen\n$ customer-export\n```\n\n### SFTP\nExported customer can be automatically uploaded to an SFTP server.\n\nWhen using SFTP you need to provide at least the required `--sftp*` options:\n- `--sftpCredentials` (or `--sftpHost`, `--sftpUsername`, `--sftpPassword`)\n- `--sftpSource`\n- `--sftpTarget`\n\n### CSV Format\nCustomers exported in CSV are stored in a single file\n\n\u003e At the moment you need to provide a `--csvTemplate` with headers in order to export related fields (see [examples](data)).\n\n```csv\nid,customerNumber\n```\n\nThe following headers can be used in the CSV template\n- `id`\n- `customerNumber`\n- `externalId`\n- `firstName`\n- `middleName`\n- `lastName`\n- `email`\n- `dateOfbirth`\n- `companyName`\n- `vatId`\n- `defaultShippingAddressId`\n- `defaultBillingAddressId`\n- `customerGroup`\n- `isEmailVerified`\n- `addressed.*` - eg. `id`, `streetName` or `additionalStreetInfo`\n\nIn general you can get access to any property of the customer object. Find a reference in our [API documentation](https://docs.commercetools.com/api/projects/customers).\n\n\u003e Note that when at least one `addresses` header is given the resulting CSV contains a row per address. Otherwise it only contains one row per customer.\n\n\n## Contributing\nIn lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).\nMore info [here](CONTRIBUTING.md)\n\n## Releasing\nReleasing a new version is completely automated using the Grunt task `grunt release`.\n\n```javascript\ngrunt release // patch release\ngrunt release:minor // minor release\ngrunt release:major // major release\n```\n\n## License\nCopyright (c) 2015 commercetools\nLicensed under the [MIT license](LICENSE-MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommercetools%2Fcommercetools-customer-export","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommercetools%2Fcommercetools-customer-export","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommercetools%2Fcommercetools-customer-export/lists"}