mayflower / shopware-attribute-rest-api
Shopware plugin that exposes free text fields (attributes) via REST API
Installs: 8
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 11
Forks: 0
Open Issues: 2
Type:shopware-plugin
This package is auto-updated.
Last update: 2024-11-07 05:27:41 UTC
README
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:
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
Return Value
GET (List)
Required Parameters
PUT
- columnName (required), string,
- unifiedType, string, defaults to
- data, array
- displayInBackend, boolean
- translatable, boolean
- core, boolean
- label, string
- ...
{
"columnName": "attr99",
"unifiedType": "text",
"data": {
"displayInBackend": true,
"translatable": true,
"core": true,
"label": "Attribut 99"
}
}
POST
- tableName (required), string
- columnName (required), string,
- unifiedType, string, defaults to
- data, array
- displayInBackend, boolean
- translatable, boolean
- core, boolean
- label, string
- ...
{
"tableName": "s_articles_attributes",
"columnName": "attr99",
"unifiedType": "text",
"data": {
"displayInBackend": true,
"translatable": true,
"core": true,
"label": "Attribut 99"
}
}
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:
config.vm.synced_folder "../ShopwareAttributeRestApi", "/home/vagrant/www/shopware/custom/plugins/ShopwareAttributeRestApi", create: true, type: "nfs"
We provide a basic Postman Collection for testing.
License
Please see License File for more information.