{"id":46310557,"url":"https://github.com/mrvdh/picnic-api","last_synced_at":"2026-05-31T20:00:58.691Z","repository":{"id":43074826,"uuid":"327400525","full_name":"MRVDH/picnic-api","owner":"MRVDH","description":"Unofficial Node.js wrapper for the API of the Picnic online supermarket. Not affiliated with Picnic.","archived":false,"fork":false,"pushed_at":"2026-04-20T10:17:02.000Z","size":433,"stargazers_count":92,"open_issues_count":2,"forks_count":16,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-04-20T12:42:46.973Z","etag":null,"topics":["api","online","picnic","supermarket"],"latest_commit_sha":null,"homepage":"","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/MRVDH.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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":"AGENTS.md","dco":null,"cla":null},"funding":{"github":["MRVDH"]}},"created_at":"2021-01-06T18:42:50.000Z","updated_at":"2026-04-20T10:26:32.000Z","dependencies_parsed_at":"2024-04-28T15:32:45.278Z","dependency_job_id":"d8e63cd9-0fcd-4707-a7c3-9d0aaeb222df","html_url":"https://github.com/MRVDH/picnic-api","commit_stats":{"total_commits":26,"total_committers":4,"mean_commits":6.5,"dds":0.1923076923076923,"last_synced_commit":"ff2fba0163f9a7ffc3bb12498b81545a38235588"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/MRVDH/picnic-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MRVDH%2Fpicnic-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MRVDH%2Fpicnic-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MRVDH%2Fpicnic-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MRVDH%2Fpicnic-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MRVDH","download_url":"https://codeload.github.com/MRVDH/picnic-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MRVDH%2Fpicnic-api/sbom","scorecard":{"id":87960,"data":{"date":"2025-08-11","repo":{"name":"github.com/MRVDH/picnic-api","commit":"7fe6c8fec7a679fd8de658f31e6d5fe472d6ee9b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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":"Maintained","score":3,"reason":"3 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"Code-Review","score":2,"reason":"Found 3/11 approved changesets -- score normalized to 2","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":"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":"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":"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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"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 27 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":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","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-952p-6rrq-rcjv"],"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-15T07:19:31.484Z","repository_id":43074826,"created_at":"2025-08-15T07:19:31.484Z","updated_at":"2025-08-15T07:19:31.484Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33746513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-31T02:00:06.040Z","response_time":95,"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","online","picnic","supermarket"],"created_at":"2026-03-04T13:07:40.359Z","updated_at":"2026-05-31T20:00:58.679Z","avatar_url":"https://github.com/MRVDH.png","language":"TypeScript","funding_links":["https://github.com/sponsors/MRVDH"],"categories":[],"sub_categories":[],"readme":"# Picnic-API\n\n[![npm version](https://img.shields.io/npm/v/picnic-api.svg?style=flat-square)](https://www.npmjs.org/package/picnic-api) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/MRVDH/picnic-api/blob/master/LICENSE) [![MAAR3267](https://img.shields.io/badge/picnic%20discount-MAAR3267-E1171E?style=flat-square)](https://picnic.app/nl/vriendenkorting/MAAR3267)\n\nUnofficial Node.js wrapper for the API of the [Picnic](https://picnic.app) online supermarket. Not affiliated with Picnic.\n\n## Installation\n\n```bash\nnpm install picnic-api\n```\n\n## Quick start\n\nImport the package and create a client. All configuration options are optional.\n\n```ts\nimport PicnicClient from \"picnic-api\";\n\nconst picnicClient = new PicnicClient({\n  countryCode: \"NL\", // The country code for the API. Options: \"NL\" (default), \"DE\" or \"FR\".\n  authKey: \"...\",    // An existing auth key to skip the login step.\n  apiVersion: \"15\",  // The API version (defaults to \"15\").\n  url: \"...\",        // A custom base URL (defaults to https://storefront-prod.\u003ccountryCode\u003e.picnicinternational.com/api/\u003capiVersion\u003e).\n  deviceId: \"...\",   // Custom device identifier for x-picnic-did header. (defaults to \"3C417201548B2E3B\")\n  agent: \"...\",      // Custom agent string for x-picnic-agent header. (defaults to \"30100;1.228.1-15480;\")\n});\n```\n\n### Authentication\n\nMost endpoints require authentication. Call `auth.login()` to obtain an auth key, which is automatically stored in the client and sent with subsequent requests. If you already have a key from a previous session, pass it as `authKey` in the constructor instead.\n\nIf the login endpoint responds with a 2FA requirement (`second_factor_authentication_required: true`), then call `auth.generate2FACode(\"SMS\")` to generate a 2FA code and pass it to `auth.verify2FA(\u003ccode\u003e)` to complete the login process.\n\n```ts\nawait picnicClient.auth.login(\"email\", \"password\");\n\n// If 2FA is required:\nawait picnicClient.auth.generate2FACode(\"SMS\");\nawait picnicClient.auth.verify2FA(\"123456\");\n```\n\n### Usage examples\n\n```ts\n// Search for products\nconst results = await picnicClient.catalog.search(\"Affligem blond\");\n\n// Add a product to the cart\nawait picnicClient.cart.addProductToCart(11295810, 2);\n\n// Bulk add products to the cart\nawait picnicClient.cart.addProductsToCart([\n  { productId: \"s11295810\", quantity: 2 },\n  { productId: \"s10000123\", quantity: 1 },\n]);\n\n// Get available delivery slots\nconst slots = await picnicClient.cart.getDeliverySlots();\n\n// Get details of a specific delivery\nconst delivery = await picnicClient.delivery.getDelivery(\"delivery-id\");\n```\n\n### Custom requests\n\nFor endpoints not yet covered by a domain service, use `sendRequest` directly:\n\n```ts\nawait picnicClient.sendRequest(\"GET\", \"/unknown/route\");\nawait picnicClient.sendRequest(\"POST\", \"/invite/friend\", { email: \"friend@example.com\" });\n```\n\n## API reference\n\nThe client exposes the following domain services, each grouping a set of related endpoints:\n\n| Service | Accessor | Description |\n| --- | --- | --- |\n| **App** | `client.app` | Bootstrap data, pages, and deeplink resolution. |\n| **Auth** | `client.auth` | Login, logout, 2FA, and phone verification. |\n| **Cart** | `client.cart` | Cart management, delivery slots and selling units (recipes, meal plans, selling groups). |\n| **Catalog** | `client.catalog` | Product search, suggestions, details, and images. |\n| **Consent** | `client.consent` | Consent settings and GDPR declarations. |\n| **Content** | `client.content` | Static content pages (FAQ, search empty state). |\n| **Customer Service** | `client.customerService` | Contact info, messages, reminders, and parcels. |\n| **Delivery** | `client.delivery` | Delivery history, live position, ratings, and invoices. |\n| **Payment** | `client.payment` | Payment profile and wallet transactions. |\n| **Recipe** | `client.recipe` | Recipe browsing and saving. |\n| **User** | `client.user` | User details, profile, suggestions, and push tokens. |\n| **User Onboarding** | `client.userOnboarding` | Household/business details and push subscriptions. |\n\nEach service method is fully typed — explore the type definitions under `src/domains/\u003cservice\u003e/types.ts` for request and response shapes.\n\n## Contributing\n\nContributions are welcome! Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines.\n\nIf you enjoy this package, consider using the discount code [MAAR3267](https://picnic.app/nl/vriendenkorting/MAAR3267) so we both get a discount on our next order. 😄\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrvdh%2Fpicnic-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrvdh%2Fpicnic-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrvdh%2Fpicnic-api/lists"}