List integrations

GET 
/integrations

Returns a list of all integrations created by the store.

Responses

200

Success. All integrations are returned.

application/json

Schema

Schema

data object[]
links object

links object

Links are used to allow you to move between requests.

self uri

Single entities use a self parameter with a link to that specific resource.

meta object

meta object

timestamps Timestamps

The date and time a transaction is created.

created_at date-time

The date and time an integration is updated.

updated_at date-time

The date and time an integration is updated.

Example (from schema)

{
  "data": [
    {
      "id": "2da46671-b4c2-44ac-b133-d1221aafc77b",
      "type": "integration",
      "name": "Order shipping notification",
      "description": "Send a shipping notification via email with discount code",
      "enabled": true,
      "integration_type": "webhook",
      "observes": [
        "string"
      ],
      "configuration": {
        "url": "https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue",
        "aws_access_key_id": "****************JIMB",
        "aws_secret_access_key": "************************************HK4o",
        "region": "eu-west-1"
      },
      "links": {
        "self": "?page[offset]=0&page[limit]=25"
      },
      "meta": {
        "timestamps": {
          "created_at": "2017-07-21T17:32:28Z",
          "updated_at": "2017-07-21T17:32:28Z"
        }
      }
    }
  ],
  "links": {
    "links": {
      "self": "?page[offset]=0&page[limit]=25"
    }
  },
  "meta": {
    "meta": {
      "timestamps": {
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:32:28Z"
      }
    }
  }
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status int
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": 500
    }
  ]
}

Loading...