Integrations
List integrations
Lists the commerce integrations the authenticated Store has connected, in
the order they were connected (their id order). Requires
integrations:read.
Overview
Follow links.next while pagination.has_more is
true. A Store can have only one enabled integration; the other rows are
integrations it disabled.
settings shows the settings of the integration type, never its
credentials, tokens or platform session ids.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: integrations:read
Query parameters
limit
Page size from 1 to 100. Defaults to 20.
Example: 20
cursor
The opaque next_cursor from a previous page.
Example: eyJ2IjoxfQ
List integrations
curl https://web.signcustomiser.com/api/v3/integrations?limit=20&cursor=eyJ2IjoxfQ \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'Response
{
"data": [
{
"object": "integration",
"id": 12,
"type": "custom",
"name": "Workshop system",
"enabled": true,
"accepts_writes": true,
"settings": {
"create_product_url": "https://workshop.example.com/sign-customiser/products"
}
},
{
"object": "integration",
"id": 9,
"type": "shopify",
"name": "Main store",
"enabled": false,
"accepts_writes": false,
"settings": {
"domain": "example.myshopify.com",
"publication_id": null,
"default_product_status": "active"
}
}
],
"pagination": {
"has_more": false,
"next_cursor": null
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/integrations",
"documentation": "https://www.signcustomiser.com/help/api/",
"next": null
},
"meta": {
"api_version": "v3",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}
}{
"type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
"title": "Missing API key",
"status": 401,
"code": "missing_api_key",
"detail": "Provide a store API key as a bearer token.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
"title": "Insufficient scope",
"status": 403,
"code": "insufficient_scope",
"detail": "This operation requires the integrations:read scope.",
"required_scopes": [
"integrations:read"
],
"granted_scopes": [
"store:read"
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/invalid_parameter",
"title": "Invalid query parameter",
"status": 422,
"code": "invalid_parameter",
"detail": "The limit parameter must be an integer between 1 and 100. Omit it to use the default of 20.",
"errors": [
{
"parameter": "limit",
"code": "invalid_parameter",
"detail": "The limit parameter must be an integer between 1 and 100. Omit it to use the default of 20."
}
],
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
"title": "Too many requests",
"status": 429,
"code": "rate_limited",
"detail": "You have exceeded the request limit for this API key.",
"retry_after": 60,
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}