Skip to Content

Read Shopify post-delivery check-in readiness

Checks selected resources and current feature availability.

GET
/v1/integrations/catalog/recipes/post-delivery-check-in/readiness

Checks selected resources and current feature availability. A namespace caller sees its reachable resources. Shopify account and plan fields are null, and full recipe readiness requires organization-wide access. Omit the email sender or WhatsApp account to see the sender or number selected for the publication and caller scope. Requires email:read and domains:read for email, or whatsappAccounts:read for WhatsApp.

Authorization

apiKey
headerx-api-key<token>

Query Parameters

channel*string
Value in"email""whatsapp"
integrationAccountId?string
Match^intgacct_[0-9a-hjkmnp-tv-z]{16,24}$
publicationId?string
Match^tpub_[0-9a-hjkmnp-tv-z]{16,24}$
senderId?string
Match^sender_[0-9a-hjkmnp-tv-z]{16,24}$
whatsappAccountId?string
Match^waba_[0-9a-hjkmnp-tv-z]{16,24}$
registrationId?string
Match^treg_[0-9a-hjkmnp-tv-z]{16,24}$
mailboxEndpointId?string
Match^mbxep_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

RecipeReadinessResponse

application/json
  1. response
ready*boolean
channel*string
Value in"email""whatsapp"
availability*
shopify*|null
publication*|null
email*|null
whatsapp*|null
reply*|null
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.integrationCatalog.recipeReadiness({
  "channel": "email"
});
Example Response
{
  "ready": true,
  "channel": "email",
  "availability": {
    "shopify": true,
    "journeys": true,
    "whatsapp": true,
    "plan": "granted"
  },
  "shopify": {
    "id": "string",
    "status": "pending",
    "shop": "string"
  },
  "publication": {
    "id": "string",
    "templateId": "string",
    "parameters": [
      {
        "name": "string",
        "required": true
      }
    ],
    "inputIssues": [
      "string"
    ]
  },
  "email": {
    "senderId": "string",
    "domainId": "string",
    "address": "string",
    "status": "ready"
  },
  "whatsapp": {
    "accountId": "string",
    "address": "string",
    "status": "ready",
    "registration": {
      "id": "string",
      "status": "draft"
    }
  },
  "reply": {
    "endpointId": "string",
    "mailboxId": "string",
    "address": "string",
    "status": "ready"
  }
}

Related documentation