Ground agents from the store: import products, collections and policies

Near-duplicates update in place, so re-running refreshes rather than duplicates.

POST /api/v1/integrations/shopify/import-knowledge

cURL

curl --request POST \
  --url 'https://response.stateset.com/api/v1/integrations/shopify/import-knowledge' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "sources": [
    "products"
  ]
}'

200

{
  "object": "knowledge.import_result",
  "provider": "shopify",
  "items_processed": 1,
  "items_created": 1,
  "items_updated": 1,
  "sources_imported": {
    "products": 1,
    "collections": 1,
    "policies": 1
  }
}

Near-duplicates update in place, so re-running refreshes rather than duplicates.

Request body

object

sources · string[]

Which store data to import. Defaults to all three.

Response

object

object · string · required

provider · string · required

items_processed · integer · required

items_created · integer · required

items_updated · integer · required

sources_imported · object · required

Item count per source. Only the sources that were imported are present.

Show sources_imported

products · integer

collections · integer

policies · integer

Status codes

Code	Meaning
200	Import counts. A connected store whose org has no knowledge base yet gets one provisioned as part of the call.
400	Invalid request. issues names the offending field(s).
401	Missing, invalid, or expired API key.
403	The key lacks a required scope.
429	Rate limit exceeded.

Access

Required scope	knowledge:write
Rate limit	30 requests per minute

cURL

curl --request POST \
  --url 'https://response.stateset.com/api/v1/integrations/shopify/import-knowledge' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "sources": [
    "products"
  ]
}'

200

{
  "object": "knowledge.import_result",
  "provider": "shopify",
  "items_processed": 1,
  "items_created": 1,
  "items_updated": 1,
  "sources_imported": {
    "products": 1,
    "collections": 1,
    "policies": 1
  }
}