Objects
.shopware-project.yml
(root object)Admin API credentials
Entity Sync Filter
MySQL dump configuration
Sync Settings
.shopware-project.yml
.shopware-project.yml
Properties
Type | Description | Required | |
---|---|---|---|
url | string |
URL to Shopware instance | No |
admin_api | AdminApi |
No | |
dump | Dump |
No | |
sync | Sync |
No |
Additional properties are not allowed.
Config.url
URL to Shopware instance
- Type:
string
- Required: No
Config.admin_api
- Type:
AdminApi
- Required: No
Config.dump
- Type:
Dump
- Required: No
Config.sync
- Type:
Sync
- Required: No
Admin API credentials
Admin API credentials
Properties
Type | Description | Required | |
---|---|---|---|
client_id | string |
Client ID of integration | No |
client_secret | string |
Client Secret of integration | No |
username | string |
Username of admin user | No |
password | string |
Password of admin user | No |
disable_ssl_check | boolean |
Disable SSL check for API requests | No, default: false |
Additional properties are not allowed.
AdminApi.client_id
Client ID of integration
- Type:
string
- Required: No
AdminApi.client_secret
Client Secret of integration
- Type:
string
- Required: No
AdminApi.username
Username of admin user
- Type:
string
- Required: No
AdminApi.password
Password of admin user
- Type:
string
- Required: No
AdminApi.disable_ssl_check
Disable SSL check for API requests
- Type:
boolean
- Required: No, default:
false
Entity Sync
Entity Sync
Properties
Type | Description | Required | |
---|---|---|---|
entity | string |
✓ Yes | |
exists | EntitySyncFilter [] |
No | |
payload | object |
API payload | ✓ Yes |
Additional properties are not allowed.
EntitySyncItem.entity
- Type:
string
- Required: ✓ Yes
EntitySyncItem.exists
- Type:
EntitySyncFilter
[]
- Required: No
EntitySyncItem.payload
API payload
- Type:
object
- Required: ✓ Yes
Entity Sync Filter
Entity Sync Filter
Properties
Type | Description | Required | |
---|---|---|---|
type | string |
filter type | ✓ Yes |
field | string |
field | ✓ Yes |
value | ["string", "integer", "array", "boolean", "null"] |
value | No |
operator | string |
No |
Additional properties are not allowed.
EntitySyncFilterInner.type
filter type
- Type:
string
- Required: ✓ Yes
- Allowed values:
"equals"
"multi"
"contains"
"prefix"
"suffix"
"not"
"range"
"until"
"equalsAll"
"equalsAny"
EntitySyncFilterInner.field
field
- Type:
string
- Required: ✓ Yes
EntitySyncFilterInner.value
value
- Type:
["string", "integer", "array", "boolean", "null"]
- Required: No
EntitySyncFilterInner.operator
- Type:
string
- Required: No
- Allowed values:
"AND"
"OR"
"XOR"
Mail Template Single Translation
Mail Template Single Translation
Properties
Type | Description | Required | |
---|---|---|---|
language | string |
No | |
sender_name | string |
No | |
subject | string |
No | |
html | string |
No | |
plain | string |
No | |
custom_fields | ["object", "null"] |
No |
Additional properties are not allowed.
MailTemplateItemTranslation.language
- Type:
string
- Required: No
MailTemplateItemTranslation.sender_name
- Type:
string
- Required: No
MailTemplateItemTranslation.subject
- Type:
string
- Required: No
MailTemplateItemTranslation.html
- Type:
string
- Required: No
MailTemplateItemTranslation.plain
- Type:
string
- Required: No
MailTemplateItemTranslation.custom_fields
- Type:
["object", "null"]
- Required: No
Mail Template Sync
Mail Template Sync
Properties
Type | Description | Required | |
---|---|---|---|
id | string |
No | |
translations | MailTemplateItemTranslation [] |
No |
Additional properties are not allowed.
MailTemplateItem.id
- Type:
string
- Required: No
MailTemplateItem.translations
- Type:
MailTemplateItemTranslation
[]
- Required: No
MySQL dump configuration
MySQL dump configuration
Properties
Type | Description | Required | |
---|---|---|---|
rewrite | object |
No | |
nodata | string [] |
No | |
ignore | string [] |
No | |
where | object |
No |
Additional properties are not allowed.
Dump.rewrite
- Type:
object
- Required: No
Dump.nodata
- Type:
string
[]
- Required: No
Dump.ignore
- Type:
string
[]
- Required: No
Dump.where
- Type:
object
- Required: No
shopware-cli
shopware cli project configuration definition file
Sync Settings
Sync Settings
Properties
Type | Description | Required | |
---|---|---|---|
config | SyncConfigItem [] |
No | |
theme | ThemeConfigItem [] |
No | |
mail_template | MailTemplateItem [] |
No | |
entity | EntitySyncItem [] |
No |
Additional properties are not allowed.
Sync.config
- Type:
SyncConfigItem
[]
- Required: No
Sync.theme
- Type:
ThemeConfigItem
[]
- Required: No
Sync.mail_template
- Type:
MailTemplateItem
[]
- Required: No
Sync.entity
- Type:
EntitySyncItem
[]
- Required: No
System Config Sync
System Config Sync
Properties
Type | Description | Required | |
---|---|---|---|
sales_channel | string |
No | |
settings | object |
✓ Yes |
Additional properties are not allowed.
SyncConfigItem.sales_channel
- Type:
string
- Required: No
SyncConfigItem.settings
- Type:
object
- Required: ✓ Yes
Theme Config Sync
Theme Config Sync
Properties
Type | Description | Required | |
---|---|---|---|
name | string |
No | |
settings | object |
No |
Additional properties are not allowed.
ThemeConfigItem.name
- Type:
string
- Required: No
ThemeConfigItem.settings
- Type:
object
- Required: No