Read Shopify post-delivery check-in readiness
Checks selected resources and current feature availability.
GET
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.
apiKeyheader
x-api-key<token>channel*stringValue in
"email""whatsapp"integrationAccountId?stringMatch
^intgacct_[0-9a-hjkmnp-tv-z]{16,24}$publicationId?stringMatch
^tpub_[0-9a-hjkmnp-tv-z]{16,24}$senderId?stringMatch
^sender_[0-9a-hjkmnp-tv-z]{16,24}$whatsappAccountId?stringMatch
^waba_[0-9a-hjkmnp-tv-z]{16,24}$registrationId?stringMatch
^treg_[0-9a-hjkmnp-tv-z]{16,24}$mailboxEndpointId?stringMatch
^mbxep_[0-9a-hjkmnp-tv-z]{16,24}$RecipeReadinessResponse
application/json- response
ready*booleanchannel*stringValue in
"email""whatsapp"availability*shopify*|nullpublication*|nullemail*|nullwhatsapp*|nullreply*|nullimport { 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"
}
}