{"id":13765417,"url":"https://github.com/buddhaCode/BucoOrderDocumentsApi","last_synced_at":"2025-05-10T21:30:58.677Z","repository":{"id":62497939,"uuid":"187847654","full_name":"buddhaCode/BucoOrderDocumentsApi","owner":"buddhaCode","description":"Shopware plugin which adds a REST API endpoint to access and delete order documents","archived":true,"fork":false,"pushed_at":"2019-05-27T07:02:02.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-11-17T01:32:49.541Z","etag":null,"topics":["document","order","shopware","shopware-api","shopware-plugin","shopware-plugins"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/buddhaCode.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}},"created_at":"2019-05-21T13:54:16.000Z","updated_at":"2023-01-28T13:59:37.000Z","dependencies_parsed_at":"2022-11-02T12:16:00.020Z","dependency_job_id":null,"html_url":"https://github.com/buddhaCode/BucoOrderDocumentsApi","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buddhaCode%2FBucoOrderDocumentsApi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buddhaCode%2FBucoOrderDocumentsApi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buddhaCode%2FBucoOrderDocumentsApi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buddhaCode%2FBucoOrderDocumentsApi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/buddhaCode","download_url":"https://codeload.github.com/buddhaCode/BucoOrderDocumentsApi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253484902,"owners_count":21915918,"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","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":["document","order","shopware","shopware-api","shopware-plugin","shopware-plugins"],"created_at":"2024-08-03T16:00:38.629Z","updated_at":"2025-05-10T21:30:58.468Z","avatar_url":"https://github.com/buddhaCode.png","language":"PHP","readme":"# BucoOrderDocumentsApi\nShopware plugin which adds a REST API endpoint to access and delete order documents.\n\n## Features\nThis plugin adds a new REST API endpoint to access and delete the order documents including\ntheir attributes. Creating and modifying order documents it currently not implemented. The access to the endpoint can be restricted with the access\ncontrol list (ACL) resource \u003ccode\u003eBucoOrderDocuments\u003c/code\u003e and the privileges \u003ccode\u003eread\u003c/code\u003e and\n\u003ccode\u003edelete\u003c/code\u003e in the user manager.\n\n\u003cp\u003eThe REST API can be accessed in the following ways:\u003c/p\u003e\n\n\n- \u003ccode\u003eGET /api/BucoOrderDocuments/\u003c/code\u003e returns a \u003cb\u003elisting\u003c/b\u003e. The \u003ca href=\"https://developers.shopware.com/developers-guide/rest-api/#filter,-sort,-limit,-offset\"\u003ewell known\u003c/a\u003e limit, order and query parameters can be applied.\n  \n  Example output: \n    ```javascript\n    {\n        \"data\": [\n            {\n                \"id\": 11756,\n                \"date\": \"2017-07-31T00:00:00+0200\",\n                \"typeId\": 1,\n                \"customerId\": 6,\n                \"orderId\": 1,\n                \"amount\": 1598,\n                \"documentId\": \"55483\",\n                \"hash\": \"7d2431092sadsa3a8047756edf0fec2da\",\n                \"attribute\": { // null, if no attributes available\n                    \"id\": 11668,\n                    \"documentId\": 11756,\n                    \"someExampleAttribute\": 42,\n                }\n            },\n            { ... }\n        ],\n        \"total\": 1337,\n        \"success\": true\n    }\n    ```\n- \u003ccode\u003eGET /api/BucoOrderDocuments/{id}\u003c/code\u003e returns a \u003cb\u003especific\u003c/b\u003e order document with a base64 encoded representation of the PDF document directly within the JSON response. To retrieve the PDF document directly without the meta data, include or set the MIME type \u003ccode\u003eapplication/pdf\u003c/code\u003e in the request header \u003ccode\u003eAccept\u003c/code\u003e.\n  \n  Example output (for JSON representation):\n    ```javascript\n    {\n        \"data\": {\n            \"id\": 11756,\n            \"date\": \"2017-07-31T00:00:00+0200\",\n            \"typeId\": 1,\n            \"customerId\": 6,\n            \"orderId\": 1,\n            \"amount\": 1598,\n            \"documentId\": \"55483\",\n            \"hash\": \"7d2431092sadsa3a8047756edf0fec2da\",\n            \"attribute\": { // null, if no attributes available\n                \"id\": 11668,\n                \"documentId\": 11756,\n                \"someExampleAttribute\": 42,\n            },\n            \"pdfDocument\": \"some random base64 encoded data[...]\" // null, if file do not exist\n        },\n        \"success\": true\n    }\n    ```\n- \u003ccode\u003eDELETE /api/BucoOrderDocuments/{id}\u003c/code\u003e deletes a \u003cb\u003especific\u003c/b\u003e order document.\n  Example output:\n    ```javascript\n    {\n        \"success\": true\n    }\n    ```\n\n## Feature Ideas\n- Implement POST and PUT methods\n  - ```POST``` Generate document via Shopware\n  - ```POST``` Upload externally generated document\n  - ```PUT``` manipulate meta data like amount and attributes\n  - ```PUT``` upload PDF file\n\n## Compatibility\n* Shopware \u003e= 5.2.0\n* PHP \u003e= 7.0\n\n## Installation\n\n### Git Version\n* Checkout plugin in `/custom/plugins/BucoOrderDocumentsApi`\n* Install and active plugin with the Plugin Manager\n\n### Install with composer\n* Change to your root installation of Shopware\n* Run command `composer require buddha-code/buco-order-documents-api`\n* Install and active plugin with `./bin/console sw:plugin:install --activate BucoOrderDocumentsApi`\n\n## Contributing\nFeel free to fork and send pull requests!\n\n## Licence\nThis project uses the [GPLv3 License](LICENCE).\n","funding_links":[],"categories":["Backend Plugins"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FbuddhaCode%2FBucoOrderDocumentsApi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FbuddhaCode%2FBucoOrderDocumentsApi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FbuddhaCode%2FBucoOrderDocumentsApi/lists"}