Connect Shopify with a custom-app Admin API token

The token is verified against the store live before it is stored, and is never returned by any read. Replacing an existing connection requires confirm_replace…

POST /api/v1/integrations/shopify

cURL

curl --request POST \
  --url 'https://response.stateset.com/api/v1/integrations/shopify' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "shop": "string",
  "access_token": "YOUR_API_KEY",
  "confirm_replace": true
}'

200

{
  "object": "integration.connection",
  "provider": "shopify",
  "connected": true,
  "shop": "string",
  "shop_name": "string",
  "scopes": "string",
  "next_action": "string"
}

The token is verified against the store live before it is stored, and is never returned by any read. Replacing an existing connection requires confirm_replace. For browser OAuth instead, use the connect_url from the status endpoint.

Request body

ConnectShopify

shop · string · required

The store handle or myshopify domain, e.g. ‘acme’ or ‘acme.myshopify.com’.

access_token · string · required

An Admin API access token (shpat_…) from a custom app.

confirm_replace · boolean

Required (true) when the organization already has a Shopify connection — connecting replaces it.

Response

object

object · string · required

provider · string · required

connected · boolean · required

shop · string · required

The normalised myshopify handle (without .myshopify.com).

shop_name · string,null · required

The store’s display name as reported by Shopify.

scopes · string,null · required

Comma-separated scopes the token was granted, when Shopify reports them.

next_action · string · required

Status codes

Code	Meaning
200	The verified connection. The token was validated with a live call to the store before being stored.
400	Invalid request. issues names the offending field(s).
401	Missing, invalid, or expired API key.
403	The key lacks a required scope.
409	Conflict — either the creation ceiling was reached for this organization (agent_limit_reached), or a request with the same Idempotency-Key is still in flight (idempotency_in_progress); retry the latter after the first attempt settles.
429	Rate limit exceeded.

Access

Required scope	agents:write
Rate limit	30 requests per minute

cURL

curl --request POST \
  --url 'https://response.stateset.com/api/v1/integrations/shopify' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "shop": "string",
  "access_token": "YOUR_API_KEY",
  "confirm_replace": true
}'

200

{
  "object": "integration.connection",
  "provider": "shopify",
  "connected": true,
  "shop": "string",
  "shop_name": "string",
  "scopes": "string",
  "next_action": "string"
}