Integrations
Get an integration
Returns one commerce integration of the authenticated Store with its
settings. Requires integrations:read.
Overview
An integration of another Store
answers the same 404 as one that never existed.
settings has the keys of the integration type, and a key that is not
set is null:
- woocommerce: api_url, the address of the WooCommerce store.
- custom: create_product_url, the address Sign Customiser sends new
products to.
- shopify: domain, the myshopify.com domain; publication_id, the
Shopify publication new products are published to; and
default_product_status, the status new products get (active or
unlisted).
- wix: version, the Wix catalogue version (v1 or v3).
- etsy: managed_by, what manages the integration.
api_url and create_product_url have only the scheme, host, port and
path of the stored address (an address stored without a scheme keeps
its host and path). A user name, password, path parameter (;…),
query string or fragment is never returned.
Credentials, tokens and platform session ids are never returned.
Authorisation
Bearer token required. Include it in the Authorization header.
Required scope: integrations:read
Path parameters
The integration id, from the list integrations operation.
Example: 12
curl https://web.signcustomiser.com/api/v3/integrations/12 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'{
"data": {
"object": "integration",
"id": 12,
"type": "shopify",
"name": "Main store",
"enabled": true,
"accepts_writes": false,
"settings": {
"domain": "example.myshopify.com",
"publication_id": "gid://shopify/Publication/1234",
"default_product_status": "active"
}
},
"links": {
"self": "https://web.signcustomiser.com/api/v3/integrations/12",
"documentation": "https://www.signcustomiser.com/help/api/"
},
"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/resource_not_found",
"title": "Resource not found",
"status": 404,
"code": "resource_not_found",
"detail": "The requested resource does not exist or does not belong to the authenticated store.",
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}{
"type": "https://www.signcustomiser.com/help/api/problems/unknown_parameter",
"title": "Unknown query parameter",
"status": 422,
"code": "unknown_parameter",
"detail": "This endpoint accepts no query parameters.",
"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"
}