Attributes
This article contains all actions for retrieving and managing attributes.
Tip
The attribute domain supports fetching related resources.
Get attribute by ID#
query {
getAttribute(id: "1", include: ["text"]) {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
}
Aimeos.query(`query {
getAttribute(id: "1", include: ["text"]) {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
}`).then(data => {
console.log(data)
})
const body = JSON.stringify({'query':
`query {
getAttribute(id: "1", include: ["text"]) {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
}`});
fetch('<GraphQL URL>', {
method: 'POST',
credentials: 'same-origin',
headers: { // Laravel only
'X-CSRF-TOKEN': '<CSRF token>'
},
body: body
}).then(response => {
return response.json();
}).then(data => {
console.log(data);
});
Response:
{
"data": {
"getAttribute": {
"id": "1",
"siteid": "1.",
"domain": "product",
"code": "demo-black",
"label": "Demo: Black",
"position": 1,
"status": 1,
"mtime": "2022-12-01 11:59:05",
"ctime": "2022-12-01 11:59:05",
"editor": "core",
"lists": {
"text": [{
"id": "1",
"item": {
"id": "10",
"content": "Test content"
}
}]
},
"property": [{
"id": "1",
"type": "title",
"languageid": "en",
"value": "Black color"
}]
}
}
}
Find attribute by code#
query {
findAttribute(code: "demo-black", domain: "product", type: "color", include: ["text"]) {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
}
Aimeos.query(`query {
findAttribute(code: "demo-black", domain: "product", type: "color", include: ["text"]) {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
}`).then(data => {
console.log(data)
})
const body = JSON.stringify({'query':
`query {
findAttribute(code: "demo-black", domain: "product", type: "color", include: ["text"]) {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
}`});
fetch('<GraphQL URL>', {
method: 'POST',
credentials: 'same-origin',
headers: { // Laravel only
'X-CSRF-TOKEN': '<CSRF token>'
},
body: body
}).then(response => {
return response.json();
}).then(data => {
console.log(data);
});
Response:
{
"data": {
"findAttribute": {
"id": "1",
"siteid": "1.",
"domain": "product",
"code": "demo-black",
"label": "Demo: Black",
"position": 1,
"status": 1,
"mtime": "2022-12-01 11:59:05",
"ctime": "2022-12-01 11:59:05",
"editor": "core",
"lists": {
"text": [{
"id": "1",
"item": {
"id": "10",
"content": "Test content"
}
}]
},
"property": [{
"id": "1",
"type": "title",
"languageid": "en",
"value": "Black color"
}]
}
}
}
Search attributes#
The filter parameter is explained in the filter section of the GraphQL basics article.
query {
searchAttributes(filter: "{\\"=~\\": {\\"attribute.code\\":\\"demo-\\"}}", include: ["text"]) {
items {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
total
}
}
const fstr = JSON.stringify(JSON.stringify(filter));
Aimeos.query(`query {
searchAttributes(filter: ` + fstr + `, include: ["text"]) {
items {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
total
}
}`).then(data => {
console.log(data)
})
let filter = {
"=~": {"attribute.code":"demo-"}
};
const fstr = JSON.stringify(JSON.stringify(filter));
const body = JSON.stringify({'query':
`query {
searchAttributes(filter: ` + fstr + `, include: ["text"]) {
items {
id
type
siteid
domain
code
label
position
status
mtime
ctime
editor
lists {
text {
id
item {
id
content
}
}
}
property {
id
type
languageid
value
}
}
total
}
}`});
fetch('<GraphQL URL>', {
method: 'POST',
credentials: 'same-origin',
headers: { // Laravel only
'X-CSRF-TOKEN': '<CSRF token>'
},
body: body
}).then(response => {
return response.json();
}).then(data => {
console.log(data);
});
Response:
{
"data": {
"searchAttributes": {
"items": [
{
"id": "1",
"siteid": "1.",
"domain": "product",
"code": "demo-black",
"label": "Demo: Black",
"position": 1,
"status": 1,
"mtime": "2022-12-01 11:59:05",
"ctime": "2022-12-01 11:59:05",
"editor": "core",
"lists": {
"text": [{
"id": "1",
"item": {
"id": "10",
"content": "Test content"
}
}]
},
"property": [{
"id": "1",
"type": "title",
"languageid": "en",
"value": "Black color"
}]
},
{
"id": "2",
"siteid": "1.",
"domain": "product",
"code": "demo-blue",
"label": "Demo: Blue",
"position": 2,
"status": 1,
"mtime": "2022-12-01 11:59:05",
"ctime": "2022-12-01 11:59:05",
"editor": "core",
"lists": {
"text": []
},
"property": []
}
],
"total": 2
}
}
}
Save single attribute#
mutation {
saveAttribute(input: {
code: "test"
type: "color"
domain: "product"
label: "Test attribute",
lists: {
text: [{
item: {
content: "Test content"
}
}]
},
property: [{
type: "title",
languageid: "en",
value: "Black color"
}]
}) {
id
}
}
Aimeos.query(`mutation {
saveAttribute(input: {
code: "test"
type: "color"
domain: "product"
label: "Test attribute",
lists: {
text: [{
item: {
content: "Test content"
}
}]
},
property: [{
type: "title",
languageid: "en",
value: "Black color"
}]
}) {
id
}
}`).then(data => {
console.log(data)
})
const body = JSON.stringify({'query':
`mutation {
saveAttribute(input: {
code: "test"
type: "color"
domain: "product"
label: "Test attribute",
lists: {
text: [{
item: {
content: "Test content"
}
}]
},
property: [{
type: "title",
languageid: "en",
value: "Black color"
}]
}) {
id
}
}`});
fetch('<GraphQL URL>', {
method: 'POST',
credentials: 'same-origin',
headers: { // Laravel only
'X-CSRF-TOKEN': '<CSRF token>'
},
body: body
}).then(response => {
return response.json();
}).then(data => {
console.log(data);
});
Response:
{
"data": {
"saveAttribute": {
"id": "18"
}
}
}
Save multiple attributes#
mutation {
saveAttributes(input: [{
code: "test-2"
type: "color"
domain: "product"
label: "Test 2 attribute",
lists: {
text: [{
item: {
content: "Test content"
}
}]
},
property: [{
id: "1",
type: "title",
languageid: "en",
value: "Black color"
}]
},{
code: "test-3"
type: "color"
domain: "product"
label: "Test 3 attribute"
}]) {
id
}
}
Aimeos.query(`mutation {
saveAttributes(input: [{
code: "test-2"
type: "color"
domain: "product"
label: "Test 2 attribute",
lists: {
text: [{
item: {
content: "Test content"
}
}]
},
property: [{
id: "1",
type: "title",
languageid: "en",
value: "Black color"
}]
},{
code: "test-3"
type: "color"
domain: "product"
label: "Test 3 attribute"
}]) {
id
}
}`).then(data => {
console.log(data)
})
const body = JSON.stringify({'query':
`mutation {
saveAttributes(input: [{
code: "test-2"
type: "color"
domain: "product"
label: "Test 2 attribute",
lists: {
text: [{
item: {
content: "Test content"
}
}]
},
property: [{
id: "1",
type: "title",
languageid: "en",
value: "Black color"
}]
},{
code: "test-3"
type: "color"
domain: "product"
label: "Test 3 attribute"
}]) {
id
}
}`});
fetch('<GraphQL URL>', {
method: 'POST',
credentials: 'same-origin',
headers: { // Laravel only
'X-CSRF-TOKEN': '<CSRF token>'
},
body: body
}).then(response => {
return response.json();
}).then(data => {
console.log(data);
});
Response:
{
"data": {
"saveAttributes": [
{
"id": "19"
},
{
"id": "20"
}
]
}
}
Delete single attribute#
mutation {
deleteAttribute(id: "18")
}
Aimeos.query(`mutation {
deleteAttribute(id: "18")
}`).then(data => {
console.log(data)
})
const body = JSON.stringify({'query':
`mutation {
deleteAttribute(id: "18")
}`});
fetch('<GraphQL URL>', {
method: 'POST',
credentials: 'same-origin',
headers: { // Laravel only
'X-CSRF-TOKEN': '<CSRF token>'
},
body: body
}).then(response => {
return response.json();
}).then(data => {
console.log(data);
});
Response:
{
"data": {
"deleteAttribute": "18"
}
}
Delete multiple attributes#
mutation {
deleteAttributes(id: ["19", "20"])
}
Aimeos.query(`mutation {
deleteAttributes(id: ["19", "20"])
}`).then(data => {
console.log(data)
})
const body = JSON.stringify({'query':
`mutation {
deleteAttributes(id: ["19", "20"])
}`});
fetch('<GraphQL URL>', {
method: 'POST',
credentials: 'same-origin',
headers: { // Laravel only
'X-CSRF-TOKEN': '<CSRF token>'
},
body: body
}).then(response => {
return response.json();
}).then(data => {
console.log(data);
});
Response:
{
"data": {
"deleteAttributes": [
"19",
"20"
]
}
}