PHPackages                             buddha-code/buco-order-documents-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. buddha-code/buco-order-documents-api

AbandonedArchivedShopware-plugin[API Development](/categories/api)

buddha-code/buco-order-documents-api
====================================

Shopware plugin which adds a REST API endpoint to access and delete order documents

04PHP

Since May 27Pushed 6y agoCompare

[ Source](https://github.com/buddhaCode/BucoOrderDocumentsApi)[ Packagist](https://packagist.org/packages/buddha-code/buco-order-documents-api)[ RSS](/packages/buddha-code-buco-order-documents-api/feed)WikiDiscussions master Synced 6d ago

READMEChangelogDependenciesVersions (1)Used By (0)

BucoOrderDocumentsApi
=====================

[](#bucoorderdocumentsapi)

Shopware plugin which adds a REST API endpoint to access and delete order documents.

Features
--------

[](#features)

This plugin adds a new REST API endpoint to access and delete the order documents including their attributes. Creating and modifying order documents it currently not implemented. The access to the endpoint can be restricted with the access control list (ACL) resource `BucoOrderDocuments` and the privileges `read` and `delete` in the user manager.

The REST API can be accessed in the following ways:

- `GET /api/BucoOrderDocuments/` returns a **listing**. The [well known](https://developers.shopware.com/developers-guide/rest-api/#filter,-sort,-limit,-offset) limit, order and query parameters can be applied.

    Example output:

    ```
    {
        "data": [
            {
                "id": 11756,
                "date": "2017-07-31T00:00:00+0200",
                "typeId": 1,
                "customerId": 6,
                "orderId": 1,
                "amount": 1598,
                "documentId": "55483",
                "hash": "7d2431092sadsa3a8047756edf0fec2da",
                "attribute": { // null, if no attributes available
                    "id": 11668,
                    "documentId": 11756,
                    "someExampleAttribute": 42,
                }
            },
            { ... }
        ],
        "total": 1337,
        "success": true
    }
    ```
- `GET /api/BucoOrderDocuments/{id}` returns a **specific** 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 `application/pdf` in the request header `Accept`.

    Example output (for JSON representation):

    ```
    {
        "data": {
            "id": 11756,
            "date": "2017-07-31T00:00:00+0200",
            "typeId": 1,
            "customerId": 6,
            "orderId": 1,
            "amount": 1598,
            "documentId": "55483",
            "hash": "7d2431092sadsa3a8047756edf0fec2da",
            "attribute": { // null, if no attributes available
                "id": 11668,
                "documentId": 11756,
                "someExampleAttribute": 42,
            },
            "pdfDocument": "some random base64 encoded data[...]" // null, if file do not exist
        },
        "success": true
    }
    ```
- `DELETE /api/BucoOrderDocuments/{id}` deletes a **specific** order document. Example output:

    ```
    {
        "success": true
    }
    ```

Feature Ideas
-------------

[](#feature-ideas)

- Implement POST and PUT methods
    - `POST` Generate document via Shopware
    - `POST` Upload externally generated document
    - `PUT` manipulate meta data like amount and attributes
    - `PUT` upload PDF file

Compatibility
-------------

[](#compatibility)

- Shopware >= 5.2.0
- PHP >= 7.0

Installation
------------

[](#installation)

### Git Version

[](#git-version)

- Checkout plugin in `/custom/plugins/BucoOrderDocumentsApi`
- Install and active plugin with the Plugin Manager

### Install with composer

[](#install-with-composer)

- Change to your root installation of Shopware
- Run command `composer require buddha-code/buco-order-documents-api`
- Install and active plugin with `./bin/console sw:plugin:install --activate BucoOrderDocumentsApi`

Contributing
------------

[](#contributing)

Feel free to fork and send pull requests!

Licence
-------

[](#licence)

This project uses the [GPLv3 License](LICENCE).

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity37

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/a7bd2c7384fe1171cadbb8cf49052126e89c0dc6f28d0da1e4029c94b2680fbc?d=identicon)[buddhaCode](/maintainers/buddhaCode)

---

Top Contributors

[![buddhaCode](https://avatars.githubusercontent.com/u/11678100?v=4)](https://github.com/buddhaCode "buddhaCode (2 commits)")

---

Tags

documentordershopwareshopware-apishopware-pluginshopware-plugins

### Embed Badge

![Health badge](/badges/buddha-code-buco-order-documents-api/health.svg)

```
[![Health](https://phpackages.com/badges/buddha-code-buco-order-documents-api/health.svg)](https://phpackages.com/packages/buddha-code-buco-order-documents-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)