IntegrationType

An object representing an integration type. Integration types are accessible to administrators only.

Properties

Property Description
auth The authentication token for the integration servers.
description Description of the integration type, by language.
name Name of the integration type, by language.
onlyFor A list of Webshop unique identifiers for which the integration type is accessible. This property is accessible only to super administrators at Abicart AB.
settingsForm URL to the form definition.
settingsSchema URL to the settings schema.
settingsUrl URL to where the settings shall be sent.
uid The unique identifier of the integration type.

Methods

count

Takes a filter object and returns the number of integration types found, as an integer.

Parameters

A filter object specifying which integration types to count. See Filter objects on the page List selection.

Example

The request below returns the number of integration types where the name in English starts with "Foo".

API Console
Integration.count(
  {
    "/name/en": {
      "startsWith": "Foo",
    }
  }
Response
2

get

Fetches information about the integration type.

Parameters

Parameter Description
uid The unique identifier of an integration type.
query Which info to return. See Query language.

Example

API Console
IntegrationType.get(5 ["name", "description"])
Response
{
  "name": "FooBank X",
  "description": "This most fabulous integration helps helps your business in more ways than three."
}

getSchema

Fetches the JSON Schema which can be used for client-side validation.

Parameters

The unique identifier of an integration type.

list

Fetches multiple integrations as an array of integration-type objects.

Parameters

Parameter Description
query Which info to return. See Query language.
selection Which integrations to list. See List selection.

Example

The following request lists all the integration types where the name in English starts with "Foo":

API Console
IntegrationType.list(["uid", {"name": "en"}], {"filters": {"/name/en": {"startsWith":"Foo"}}})
Response
[
  {
    "name": {
      "en": "FooBank X"
    },
    "uid": 5
  }
  {
    "name": {
      "en": "Foobar unlimited"
    },
    "uid": 6
  }
]