Plugins

This article contains all actions for retrieving and managing plugins.

Get plugin by ID

QueryJavascript

query {
  getPlugin(id: "1") {
    id
    siteid
    type
    label
    provider
    config
    position
    status
    mtime
    ctime
    editor
  }
}

const body = JSON.stringify({'query':
`query {
  getPlugin(id: "1") {
    id
    siteid
    type
    label
    provider
    config
    position
    status
    mtime
    ctime
    editor
  }
}`});

fetch($('.aimeos').data('graphql'), {
    method: 'POST',
    credentials: 'same-origin',
    headers: { // Laravel only
        'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
    },
    body: body
}).then(response => {
    return response.json();
}).then(data => {
    console.log(data);
});

Response:

{
  "data": {
    "getPlugin": {
      "id": "1",
      "siteid": "1.",
      "type": "catalog",
      "label": "+10% Test",
      "provider": "Percent",
      "datestart": null,
      "dateend": null,
      "config": "{\"last-plugin\":0,\"percent\":10}",
      "position": 0,
      "status": 1,
      "mtime": "2022-12-22 09:51:38",
      "ctime": "2022-06-21 13:36:28",
      "editor": "aimeos@aimeos.org"
    }
  }
}

Search plugins

The filter parameter is explained in the filter section of the GraphQL basics article.

QueryJavascript

query {
  searchPlugins(filter: "{\"~=\": {\"plugin.label\":\"Product\"}}") {
    id
    siteid
    type
    label
    provider
    config
    position
    status
    mtime
    ctime
    editor
  }
}

let filter = {
    "~=": {"plugin.label":"Product"}
};
const fstr = JSON.stringify(filter).replace(/"/g, '\\"');
const body = JSON.stringify({'query':
`query {
  searchPlugins(filter: "` + fstr + `") {
    id
    siteid
    type
    label
    provider
    config
    position
    status
    mtime
    ctime
    editor
  }
}`});

fetch($('.aimeos').data('graphql'), {
    method: 'POST',
    credentials: 'same-origin',
    headers: { // Laravel only
        'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
    },
    body: body
}).then(response => {
    return response.json();
}).then(data => {
    console.log(data);
});

Response:

{
  "data": {
    "searchPlugins": [
      {
        "id": "1",
        "siteid": "1.",
        "type": "catalog",
        "label": "+10% Test",
        "provider": "Percent",
        "datestart": null,
        "dateend": null,
        "config": "{\"last-plugin\":0,\"percent\":10}",
        "position": 0,
        "status": 1,
        "mtime": "2022-12-22 09:51:38",
        "ctime": "2022-06-21 13:36:28",
        "editor": "aimeos@aimeos.org"
      }
    ]
  }
}

Save single plugin

MutationJavascript

mutation {
  savePlugin(input: {
    type: "order"
    label: "Test plugin"
    provider: "Shipping"
    config: "{\"threshold\": "50.00"}"
    status: 0
  }) {
    id
  }
}

const body = JSON.stringify({'query':
`mutation {
  savePlugin(input: {
    type: "order"
    label: "Test plugin"
    provider: "Shipping"
    config: "{\"threshold\": "50.00"}"
    status: 0
  }) {
    id
  }
}`});

fetch($('.aimeos').data('graphql'), {
    method: 'POST',
    credentials: 'same-origin',
    headers: { // Laravel only
        'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
    },
    body: body
}).then(response => {
    return response.json();
}).then(data => {
    console.log(data);
});

Response:

{
  "data": {
    "savePlugin": {
      "id": "13"
    }
  }
}

Save multiple plugins

MutationJavascript

mutation {
  savePlugins(input: [{
    type: "order"
    label: "Test plugin 2"
    provider: "Shipping"
    config: "{\"threshold\": "25.00"}"
    status: 0
  },{
    type: "order"
    label: "Test plugin 3"
    provider: "Example"
    config: "{}"
    status: 0
  }]) {
    id
  }
}

const body = JSON.stringify({'query':
`mutation {
  savePlugins(input: [{
    type: "order"
    label: "Test plugin 2"
    provider: "Shipping"
    config: "{\"threshold\": "25.00"}"
    status: 0
  },{
    type: "order"
    label: "Test plugin 3"
    provider: "Example"
    config: "{}"
    status: 0
  }]) {
    id
  }
}`});

fetch($('.aimeos').data('graphql'), {
    method: 'POST',
    credentials: 'same-origin',
    headers: { // Laravel only
        'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
    },
    body: body
}).then(response => {
    return response.json();
}).then(data => {
    console.log(data);
});

Response:

{
  "data": {
    "savePlugins": [
      {
        "id": "14"
      },
      {
        "id": "15"
      }
    ]
  }
}

Delete single plugin

MutationJavascript

mutation {
  deletePlugin(id: "13")
}

const body = JSON.stringify({'query':
`mutation {
  deletePlugin(id: "13")
}`});

fetch($('.aimeos').data('graphql'), {
    method: 'POST',
    credentials: 'same-origin',
    headers: { // Laravel only
        'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
    },
    body: body
}).then(response => {
    return response.json();
}).then(data => {
    console.log(data);
});

Response:

{
  "data": {
    "deletePlugin": "13"
  }
}

Delete multiple plugins

MutationJavascript

mutation {
  deletePlugins(id: ["14", "15"])
}

const body = JSON.stringify({'query':
`mutation {
  deletePlugins(id: ["14", "15"])
}`});

fetch($('.aimeos').data('graphql'), {
    method: 'POST',
    credentials: 'same-origin',
    headers: { // Laravel only
        'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
    },
    body: body
}).then(response => {
    return response.json();
}).then(data => {
    console.log(data);
});

Response:

{
  "data": {
    "deletePlugins": [
      "14",
      "15"
    ]
  }
}