Download the PHP package mayflower/shopware-attribute-rest-api without Composer
On this page you can find all versions of the php package mayflower/shopware-attribute-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mayflower/shopware-attribute-rest-api
More information about mayflower/shopware-attribute-rest-api
Files in mayflower/shopware-attribute-rest-api
Package shopware-attribute-rest-api
Short Description Shopware plugin that exposes free text fields (attributes) via REST API
License MIT
Informations about the package shopware-attribute-rest-api
ShopwareAttributeRestApi
A Shopware plugin that exposes the free text fields (attributes) via REST API.
About
This plugin uses the Attribute Crud Service to expose attributes vie REST API.
It's intended to be used for automation of the free text field management.
Setup
Enable API Access as explained in Shopware's REST API Documentation.
Usage
The attributes
resource supports the following operations:
Name | Access URL | GET | GET (List) | PUT | PUT (Batch) | POST | DELETE | DELETE (Batch) |
---|---|---|---|---|---|---|---|---|
attributes | /api/attributes | Yes | YES | YES | NO | YES | YES | NO |
Due to the design of Shopware's attribute crud service, it might be possible to update with POST and create with PUT!
GET
table_name is used as ID.
Required Parameters
Identifier | Parameter | Example call |
---|---|---|
column_name | string | /api/attributes/s_article_attributes?column_name=attr1 |
Return Value
GET (List)
Required Parameters
Identifier | Parameter | Example call |
---|---|---|
table_name | string | /api/attributes/s_article_attributes |
PUT
- columnName (required), string,
- unifiedType, string, defaults to
- data, array
- displayInBackend, boolean
- translatable, boolean
- core, boolean
- label, string
- ...
POST
- tableName (required), string
- columnName (required), string,
- unifiedType, string, defaults to
- data, array
- displayInBackend, boolean
- translatable, boolean
- core, boolean
- label, string
- ...
DELETE
Contributing
We use Shopware's Vagrant Setup for development.
After Setup, you map/sync the plugin code into the vagrant box.
One way to do this, is updating the Vagrantfile
with something similar like this:
We provide a basic Postman Collection for testing.
License
Please see License File for more information.