Sign Customiser

Navigation

Dark mode

Returns one commerce integration of the authenticated Store with its settings. Requires integrations:read.

GET/api/v3/integrations/{integration_id}
GETGet an integration
GET/api/v3/integrations/{integration_id}

Get an integration

Returns one commerce integration of the authenticated Store with its settings. Requires `integrations:read`. 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

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

The integration id, from the list integrations operation.

Get an integration

Click Send to see the live response.

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

integration_idstringpathrequired

The integration id, from the list integrations operation.

Example: 12

Get an integration
curl https://web.signcustomiser.com/api/v3/integrations/12 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "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 a question and press Enter. Use the arrow keys to move between the results.