Queries
attributionSettings(Experimental) — How this store attributes orders to its marketing messages: the default attribution model and which evidence counts, with its window. Reading never changes anything.backInStockSubscriptions— List back-in-stock subscriptions for this store, oldest first.campaign— Fetch a single campaign by its id. Ids from earlier versions of the Redo API are also accepted.campaigns— List campaigns, optionally filtered by name, channel, status, tag, or when they finished sending. For sends, opens, clicks and revenue, selectanalytics { messaging(startDate:, endDate:) }on each node, andanalytics { variants(startDate:, endDate:) }for each split-test arm; one range is read once for the whole page.campaignSendCheck— Check a campaign before sending or scheduling it, without changing it: what blocks the send, how many customers it reaches, whether that is a large send for email, and whether the time is in SMS quiet hours. It applies the rules the Redo app applies, andcampaignSendrefuses the blockers. It runs one audience estimate, cached for 5 minutes, which can take a while for a large dynamic segment. The quiet-hours check usesat, elselocalTime, else the campaign’s saved schedule, else now. Returns null if no campaign with that id is owned by the caller.commerceAgentStrategies— Commerce Agent strategies on this store, newest first, optionally filtered by name. At most 100 are returned; narrow withqueryto reach older ones.commerceAgentStrategy— Look up a Commerce Agent strategy by id. Returns null when this store has no strategy with that id.customerCustomFieldDeclaration— Fetch a single customer custom field declaration by its id. Ids from earlier versions of the Redo API are also accepted.customerCustomFieldDeclarations— List customer custom field declarations in this store’s catalog, optionally filtered by name or data type.customerTag— Fetch a single customer tag by its id. Ids from earlier versions of the Redo API are also accepted.customerTags— List customer tags in this store’s catalog, optionally filtered by name, provider, or source.discountCode— Fetch a single discount configuration by its id. Ids from earlier versions of the Redo API are also accepted.discountCodes— List discount configurations, optionally filtered by title or code text, exact checkout code, platform, group type, or kind.emailAddresses— Mailboxes the store can use as a campaign From or Reply-To address.emailDomain— Get one of the store’s email domains by id. Returns null if no domain of the store matches.emailDomains— Domains the store sends email from, with the DNS records each one needs.emailTemplate— Fetch a single email template by its id. Ids from earlier versions of the Redo API are also accepted.emailTemplates— List email templates, optionally filtered by name or trigger.emailTemplateVariableCatalog— The static email-template variable grammar for a trigger: template variable names, Url keys, context objects, and table collection paths. Does not include this store’s discounts, saved sections, or product filters. UNKNOWN returns empty lists.generatedDiscountCodes(Experimental) — List the unique codes generated from one discount configuration, newest first, as the discount page shows them. The list is search-indexed and can trail a new code by a few seconds. An unknown discount returns no codes.marketingAutomation— Fetch a single marketing automation by its id. Ids from earlier versions of the Redo API are also accepted. Also returns a Redo default automation this store sees (origin: DEFAULT).marketingAutomationCatalog— This store’s automation grammar: trigger keys createMarketingAutomation accepts, which step kinds aninsertoperation accepts for each trigger, and the fields, predicate JSON Schema, and triggerSpecificFields JSON Schema for each trigger. Read it before creating an automation, inserting a step, or writing a condition.marketingAutomations— List marketing automations, optionally filtered by name, category, channel, or whether they are running. For sends, opens, clicks and revenue, selectanalytics { messaging(startDate:, endDate:) }on each node; one range is read once for the whole page.marketingEmailSettings— The store’s default From and Reply-To addresses for marketing emails.messageDecisions(Experimental) — Why Redo did or didn’t message shoppers: each decision to send, skip, wait or branch, newest first. Filters combine with AND.orderLookup— Fetch the store’s Shopify order-lookup embed. Returns null until one has been created.popup(Experimental) — Fetch a single popup by its id. Ids from earlier versions of the Redo API are also accepted.popups(Experimental) — List this store’s popups, optionally filtered by status.productFilter— Fetch one product filter saved on this account. An id from another account, or one that does not exist, is null.productFilterCollection— One collection on this account’s connected store. An id that store does not have is null. Uses the account’s saved integration only.productFilterCollections— Collections on this account’s connected store for the given provider. Uses that account’s saved integration only — there is no shop domain or token argument. A provider this account has not connected returns an empty list. At most 100 collections are returned.productFilterMetafields— Product metafield definitions from this account’s Shopify Admin API, using the account’s saved Shopify connection. Accounts without Shopify get an empty list. Definitions are capped at 100. Provider errors do not include the Shopify response.productFilters— Product filters saved on this account.segment— Fetch a single segment by its id. Ids from earlier versions of the Redo API are also accepted.segmentConditionCatalog— The static segment condition grammar: fields, operators, and the JSON Schema forconditions. Does not include this store’s tags, products, or customers.segments— List segments, optionally filtered by name or by how membership is set.segmentTokenFieldOptions— Look up this store’s allowed values for a catalog field (tags, products, countries, custom fields, event names). The catalog is static; these values are not.smsKeyword(Experimental) — Fetch one SMS subscribe keyword by its id. Returns null if no keyword in this store has the id.smsKeywords(Experimental) — List the store’s SMS subscribe keywords, optionally only active or only paused ones.smsTemplate— Fetch a single SMS template by its id. Ids from earlier versions of the Redo API are also accepted.smsTemplates— List SMS templates, optionally filtered by name or trigger.trackingPage— Fetch a single tracking page by its id or legacyId. Returns null if no owned tracking page matches.trackingPageBlockSchema(Experimental) — JSON Schema forTrackingPage.blocks.trackingPages— List the store’s tracking pages.
Mutations
attributionSettingsReset(Experimental) — Put every attribution setting back to its default: last touch as the default model, and each kind of evidence switched on or off with its window as a new store has it. Returns the settings after the reset.attributionSettingsUpdate(Experimental) — Change how this store attributes orders to its marketing messages, the same settings the Redo app’s attribution page saves. Only the fields you pass change. Returns the settings after the change. BAD_USER_INPUT (400) for a null, a window of zero or past 30 days, a window onCODE_REDEEMEDorMEANINGFUL_CONVERSATION, or a kind of evidence listed twice; nothing is saved then.campaignSend— Send a campaign now, as Send now in the Redo app does: it schedules the campaign for the current time and starts the send at once. It works on a draft and on a campaign scheduled for later whose send has not started; the new time replaces the old schedule, andscheduledAtTimeZoneis left as it was. Nothing is saved when the send is refused. It fails withCAMPAIGN_NOT_SENDABLE(400) when the campaign has no segment, an email variant lacks a subject or preview text, or marketing billing is off for its channel (campaignSendChecklists them), and withCAMPAIGN_SEND_STARTED(400) when the send has already started. There is no idempotency key because the campaign is the key: repeating the call after the send started fails withCAMPAIGN_SEND_STARTED, so read the campaign’sstatusto see the outcome. An SMS campaign sent outside texting hours, 8:00 to 20:00 in part of the continental US, fails withSMS_QUIET_HOURS(400) unlesssendDuringQuietHoursis true; that acknowledges the risk of texting outside those hours, because Redo does not hold a campaign’s texts for quiet hours once its send starts.updateCampaignis unchanged: it schedules and edits without these checks. Returns null if no campaign with that id is owned by the caller.cancelCampaign— Stop an in-progress campaign. Returns null if no campaign with that id is owned by the caller.commerceAgentStrategyPublish(Experimental) — Publish a Commerce Agent strategy’s stageddraft, so agents use its guidance. Fails withCOMMERCE_AGENT_STRATEGY_REVISION_STALEwhen the draft changed sinceexpectedRevision, including when another draft was published since. Repeating a publish that already went live returns the strategy unchanged. Returns null when this store has no strategy with that id.createCampaign— Create a campaign shell. Email requiressubjectandpreviewText. Set the audience and schedule withupdateCampaign.createCommerceAgentStrategy— Create a Commerce Agent strategy. Set its id asstrategyIdwhen inserting a Start Agent Conversation step.createCustomerTag— Create a customer tag in this store’s Redo catalog. The tag’s source is Redo Marketing.createDiscountCode— Create a discount code on Shopify or BigCommerce. The same input is used for both providers.createDynamicSegment— Create a dynamic segment from a condition tree. Attach it to a campaign with updateCampaign.segmentIds.createEmailTemplate— Create an email template.triggeris required and cannot be UNKNOWN. Optionaloperationsare applied to the default sections.createMarketingAutomation— Create an automation for a trigger listed in marketingAutomationCatalog. Returns the new automation. Date and price-drop triggers are not supported.createMarketingImageUpload— Start an image upload for a file on disk. PUT the file’s raw bytes to the returnedurlbeforeexpiresAt, then calluploadMarketingImagewithsource: { uploadId }to compress and host it. Counts against the image upload quota.createProductFilter— Save a product filter on this account. The returnedidis what an email block stores.createSampledSegment— Create a new static segment holding a random sample of up tosampleSizemembers of a static or dynamic segment. A source with fewer members is copied whole, and an empty source (or a dynamic one with no conditions) gives an empty segment. A dynamic source is sampled from the same periodically refreshed data as itsmemberCount, not live. The source is unchanged, and each call draws a new sample. Returns null if the caller owns no segment with that id. Fails with UNSUPPORTED_SEGMENT_TYPE for persona segments. The call waits for the write and can take over a minute for a large segment, so if it times out, look the segment up by name before retrying.createSmsTemplate— Create an SMS template.triggeris required and cannot be UNKNOWN.customerCustomFieldDeclarationCreate— Create a typed customer custom field declaration in this store’s catalog without writing a customer record. Idempotent when a declaration with the same name and dataType already exists; errors withCUSTOM_FIELD_TYPE_CONFLICTif one exists with a different dataType.customerCustomFieldDeclarationDelete— Delete a customer custom field declaration from this store’s catalog. Returns true if an owned declaration was deleted, false if none matched.deleteCampaign— Delete a campaign that has not started sending. Returns true if an owned campaign was deleted, false if none matched.deleteDiscountCode— Delete a discount code. Returns true if an owned code was deleted, false if none matched. On Shopify the platform discount is deleted too; on BigCommerce only the Redo record is removed.deleteEmailTemplate— Delete an email template. Returns true if an owned template was deleted, false if none matched.deleteMarketingAutomation— Delete an automation and stop its in-flight runs. Returns true if an owned automation was deleted, false if none matched.deleteProductFilter— Delete a product filter on this account. Returns false when the id is missing or belongs to another account. Interactive cart sections on this account that stored the id have that reference cleared.deleteSegment— Delete a segment. Returns true if an owned segment was deleted, false if none matched.deleteSmsTemplate— Delete an SMS template. Returns true if an owned template was deleted, false if none matched.duplicateCampaign— Copy a campaign into a new draft: its audience, tags, sender, follow-up email and send settings, and a new copy of each email or SMS variant. The copy has no schedule and sends nothing untilupdateCampaignschedules it. Returns null if no campaign with that id is owned by the caller.duplicateMarketingAutomation— Copy an automation into a new automation that is off: its steps, and a new copy of each email or SMS template, Recover config and Commerce Agent strategy they use. Turn the copy on withupdateMarketingAutomation. Returns null if no owned automation matches the id.emailDomainCreate— Add a domain the store sends email from, and start verifying it with the email provider. Publish itsdnsRecordsat the store’s DNS provider, then callemailDomainVerify. Errors withINVALID_DOMAINif it isn’t a valid domain,DOMAIN_UNAVAILABLEif another store uses it, andDOMAIN_ALREADY_REGISTEREDif the email provider already has it.emailDomainDelete— Remove an email domain from the store, along with the store’s sender addresses on it. Returns true if a domain of the store was removed, false if none matched. Errors withEMAIL_DOMAIN_IN_USEwhile a support email sender sends through it; remove those senders first.emailDomainMailFromSet— Set the MAIL FROM domain bounces return through, as a subdomain of the email domain, and start verifying it. Publish the MAIL FROM records indnsRecords, then callemailDomainVerify. Returns null if no domain of the store matches the id. Errors withINVALID_SUBDOMAINif the subdomain isn’t a single DNS label.emailDomainVerify— Check the domain’s DNS records and verification with the email provider now, instead of waiting for the next background check. A domain checked in the last few seconds isn’t checked again. Returns null if no domain of the store matches the id.emailSenderCreate— Add a sender address the store can use as a campaign From or Reply-To address. Errors withINVALID_EMAILifemailisn’t a full address,INVALID_LOCAL_PARTif the part before the@has invalid characters or dots,INVALID_DOMAINif the domain isn’t valid,DOMAIN_UNAVAILABLEif another store has registered the domain, andEMAIL_SENDER_EXISTSif the store already has the address with this name.emailSenderDelete— Remove a sender address. Returns true if an owned sender address was removed, false if none matched. Errors withEMAIL_SENDER_IS_DEFAULTif the address is the store’s default sender or reply-to; choose another default first.emailSenderSendVerification— Email a sender address a link that confirms it receives email. Opening the link in the Redo dashboard sets itsmailboxVerifiedAt. Returns null if no owned sender address matches the id. Errors withNOT_A_MAILBOXunless the address is marked as a mailbox, and withALREADY_VERIFIEDif it is verified.emailSenderUpdate— Change a sender address’s display name or whether it can receive email. Returns null if no owned sender address matches the id. Errors withEMAIL_SENDER_EXISTSif the store already has the address with the new name.emailTemplateLocalizationSave— Set an email template’s source language and save its translations. Each language intranslationsreplaces that language’s saved copy, and each indeleteLocalesis deleted; other saved languages are kept. Selectlocalizationon the result to read them back. Returns null if no owned template matches the id. Throws a 400 error with an extension code of INVALID_EMAIL_TEMPLATE_TRANSLATION when a language repeats, is the source language, a key is not inlocalization.entries, or a translation drops or breaks an HTML tag or{{ }}placeholder of the source; DUPLICATE_TRANSLATION_KEY when a key repeats within a language; and TOO_MANY_LANGUAGES past 20 languages. A request rejected with one of these errors saves nothing. Editing the template’s source text later re-translates every saved language in full, replacing hand-edited strings.emailTemplateSendTest— Send a test email of a saved template, one email per address, as the template builder’s Send test email does. Sends the saved template, not unsaved edits. Takes up to 20 addresses per call, and counts toward the store’s 100 test recipients per day, shared with the Redo app.orderNumberfills the email with that order’s data, or with its return or Try-first contract for those templates; when it is omitted or matches nothing, the email carries sample data (seesampleData). A call that fails may already have sent to some addresses. Returns null if no template with that id is owned by the caller.emailTemplateTranslate— Draft translations of an email template’s copy into other languages, for review. Nothing is saved: pass the drafts you keep, edited or not, toemailTemplateLocalizationSave. A language the translator could not produce safely comes back with no texts. Returns null if no owned template matches the id. Throws a 400 error with an extension code of INVALID_EMAIL_TEMPLATE_TRANSLATION whentargetLocalesrepeats a language or includessourceLocale, and TOO_MANY_LANGUAGES past 20 languages.marketingContactsSuppress— Stop this store’s marketing to up to 100 email addresses and phone numbers, whether or not they belong to a customer yet. Consent status is unchanged. Returns one result per distinct contact, emails first, in the order given. INVALID_EMAIL or INVALID_PHONE_NUMBER (400) when any contact can’t be read, and then nothing is changed.marketingContactsUnsuppress— Lift this store’s suppression of up to 100 email addresses and phone numbers. Contacts Redo suppresses for every store are left as they are and reported as SUPPRESSED_FOR_ALL_STORES. Returns one result per distinct contact, emails first, in the order given. INVALID_EMAIL or INVALID_PHONE_NUMBER (400) when any contact can’t be read, and then nothing is changed.marketingEmailSettingsUpdate(Experimental) — Set the store’s default From and Reply-To addresses for marketing emails, as on the email domain settings page. Errors withINVALID_SENDER_IDif an id isn’t one of the store’s addresses, and withSENDER_DOMAIN_NOT_VERIFIEDif the default sender isn’t on a DKIM-verified domain.orderLookupCreate— Create the store’s Shopify order-lookup embed with default settings when none exists, or return the existing embed.productBackInStockNotify— Queues a back-in-stock send for every subscriber still waiting on this product. Sends asynchronously. When a send for this variant is already running, this call adds nobody and reportsALREADY_RUNNING. Returns null if no product with that id is owned by the caller.revertMarketingAutomation— Revert a store’s customized Return tracking automation to Redo’s default by deleting the store’s version. Redo’s default for that trigger runs again once the store has no other automation, on or off, for the trigger. Runs of the store’s version already in progress finish. Returns true if an owned automation was reverted, false if none matched. Errors with AUTOMATION_NOT_REVERTIBLE if the automation is not a customized Redo default.segmentsDelete— Delete several segments at once, with their snapshots; a static segment’s members lose that membership. This cannot be undone. Returns the passed ids that matched one of the store’s segments and were deleted; other ids are skipped. Fails with CANNOT_DELETE_PROTECTED_SEGMENT, deleting nothing, if the list holds the Texas SMS exclusion segment. If the call fails partway, some segments may already be deleted; repeating it is safe.smsKeywordCreate(Experimental) — Create an active SMS subscribe keyword. A customer who texts it to the store’s number is subscribed to SMS marketing and given its tags.smsKeywordDelete(Experimental) — Delete an SMS keyword. Texting it no longer subscribes anyone; customers it already subscribed stay subscribed. Returns true if a keyword in this store was deleted, false if none has the id.smsKeywordUpdate(Experimental) — Change an SMS keyword’s text or tags, or pause or resume it withstatus. Returns null if no keyword in this store has the id.trackingPageCreate— Create a tracking page with default layout blocks and the given name.trackingPageDelete— Delete a tracking page and return its snapshot prior to deletion. Returns null if no owned tracking page matches.trackingPageDuplicate— Duplicate a tracking page as stored, naming the copy ”${name} (Copy)”. Returns null if no owned tracking page matches.trackingPageSetDefault— Set a tracking page as the store’s default, clearingisDefaulton the store’s other pages. Returns null if no owned tracking page matches.trackingPageUpdate— Update a tracking page’s name or blocks. Returns null if no owned tracking page matches the id.updateCampaign— Update a campaign. Returns null if no campaign with that id is owned by the caller.updateCommerceAgentStrategy— Update a Commerce Agent strategy. Guidance is staged in the strategy’sdraft, and agents keep using the published guidance untilcommerceAgentStrategyPublishpublishes it;nameanddiscountCodeIdchange the strategy at once. Returns null when this store has no strategy with that id.updateCustomerTag— Rename a customer tag. Returns null if no owned tag matches the id.updateDiscountCode— Update a discount code. Returns null if no code with that id is owned by the caller.updateDynamicSegment— Update a dynamic segment. Returns null if no owned segment matches the id.updateEmailTemplate— Update template metadata and/or apply section operations. Returns null if no owned template matches the id. Passinput,operations, or both.updateMarketingAutomation— Update automation metadata and/or apply step operations. Returns null if no owned automation matches the id. Passinput,operations, or both. Turn it off withstopActiveRuns: trueto also stop its runs in progress.updateProductFilter— Replace a product filter on this account. An id from another account, or one that does not exist, is null.updateSmsTemplate— Update an SMS template. Returns null if no owned template matches the id.uploadMarketingImage— Upload an image for an SMS or email template. Redo checks the real file type, then resizes and compresses it with the same settings as the template editors, and returns a hosted URL. Each upload costs query points by size and also counts against a per-account upload quota; over the quota returns THROTTLED.
Objects
AddedToCartProductFilter— Recommends products this customer added to cart in the window.AmountOffDiscountSettings— A percent-off or amount-off discount.AttributionEvidenceSetting— Whether one kind of evidence counts, and for how long.AttributionSettings— How this store attributes orders to its marketing messages: the settings on the Redo app’s attribution page. Campaign and automation analytics follow them.AttributionWindow— How far back from an order a message’s evidence still counts. At most 30 days.BackInStockSubscription— One shopper’s request to be told when a product is back in stock. A shopper who subscribes again after being notified is a new row.BestSellersProductFilter— Recommends the store’s best sellers.BuyXGetYDiscountSettings— A buy-X-get-Y discount.Campaign— A one-off marketing send to a set of segments, on a single channel.CampaignAnalytics— Analytics for this campaign. Each field beneath is a separate read against a different store, with its own arguments and its own scope.CampaignEmailVariant— One version of a campaign’s email content, with the share of recipients it was sent to.CampaignFollowUpConfig— Follow-up email settings when the merchant enabled one.CampaignMessagingAnalytics— Email and SMS performance for this campaign over a date range, at whichever grain you ask for.CampaignQuietHours— Whether an SMS send time falls outside texting hours, 8:00 to 20:00. With no known recipient time zone, that is judged in every continental US time zone.CampaignSendCheck— What the Redo app checks before it sends a campaign: what blocks the send, the audience size, whether the send is unusually large, and whether the time is in SMS quiet hours.CampaignSmsVariant— One version of a campaign’s SMS content, with the share of recipients it was sent to.CampaignVariantAnalytics(Experimental) — One arm of a campaign’s split test: what it sent, how it was engaged with, and the orders and revenue credited to it over a date range. Rates are as onMessageAnalytics. Unsubscribes are not recorded per arm; readmessaging.totals.unsubscribes. Credit to a campaign message that carries no template is inmessagingbut in no arm, so arms need not sum to it. Arms are matched to activity by template: two arms that use the same template each report that template’s full figures, and activity for a template that is no longer an arm is left out.CollectionProductFilter— Recommends products from one collection.CommerceAgentStrategy— Guidance for a Commerce Agent conversation started by a Start Agent Conversation automation step: the goal, how to write the outreach, and an optional discount code the agent may offer. The guidance fields are the published guidance that agents use; a change staged byupdateCommerceAgentStrategywaits indraftuntil it is published.CommerceAgentStrategyDraft(Experimental) — Guidance staged on a Commerce Agent strategy. Agents do not use it until you publish it withcommerceAgentStrategyPublish.CustomerCustomFieldDeclaration— A typed custom field declaration (custom property) on this store’s customers.CustomerTag— A named customer tag in this store’s Redo catalog. Shopify-originated tags are stored here after sync; this API never queries Shopify.DiscountBxgyCustomerBuys— The X side of a buy-X-get-Y discount.DiscountBxgyCustomerGets— The Y side of a buy-X-get-Y discount.DiscountCatalogItem— A product or collection this discount applies to, identified by the platform’s id.DiscountCode— A discount configuration hosted on Shopify or BigCommerce.DiscountCodeExpiration— When this discount code stops working.DiscountCombinesWith— Which other discounts this code may stack with.DiscountMinRequirement— A minimum purchase required to use the code.DynamicRangeDiscountSettings— A unique-code percentage range. Readable, but cannot be created here.DynamicRangeRelativeExpiration— How long a minted unique code stays valid after it is generated.EmailAddress— An email address with an optional display name.EmailDomain— A domain the store sends email from, as set up under email domains. It can send once its DKIM record is verified.EmailDomainDnsRecord— A DNS record the store publishes at its DNS provider so the domain can send.EmailSender— A From or Reply-To mailbox on the store, as configured under email domains.EmailTemplate— The content of an email, as the merchant authored it.EmailTemplateBrandKitButtonBorder— Brand-kit button border.EmailTemplateBrandKitButtonOverride— Brand-kit button override.EmailTemplateBrandKitEmailButton— A brand-kit styled button used inside skip-or-delay.EmailTemplateBrandKitFont— Brand-kit font.EmailTemplateBrandKitStroke— Brand-kit border stroke.EmailTemplateButtonSection— A button section.EmailTemplateChromeDinoSection— The Chrome dinosaur game.EmailTemplateColumnSection— A multi-column layout. Child blocks keep their own ids.EmailTemplateColumnSlot— One column slot.sectionis null when the merchant left the slot empty.EmailTemplateContextObject— A structured trigger field blocks bind throughschemaFieldName(cartContext,reviewRequest,tracker,orderSummary).EmailTemplateDelayOption— A skip-or-delay duration choice.EmailTemplateDiscountSection— A discount code block.EmailTemplateFooterSection— A footer section, including the unsubscribe link field.EmailTemplateHeaderSection— A header / logo section.EmailTemplateHtmlSection— A raw HTML section.EmailTemplateImageSection— An image section.EmailTemplateInlineButton— A button drawn inside a products block. It has no link picker; the products block supplies the destination.EmailTemplateLineSection— A horizontal rule.EmailTemplateLocalization— An email template’s source language and its saved translations.EmailTemplateManualProduct— A product chosen by hand.productIdandvariantIdare the store’s ids, not Redo catalog ids.EmailTemplateMenuItem— One menu link.EmailTemplateMenuSection— A link menu.EmailTemplatePadding— Pixel padding on each side of a section.EmailTemplatePreview— The template rendered the way it would be sent, with sample data or a recent event’s. Rendering is costly, so ask for only the fields you need.EmailTemplateProductCardContent— Which parts of a shoppable product card are visible.EmailTemplateProductsSection— Product recommendations. The template trigger must provide Cart Context.schemaFieldNamedefaults tocartContext.recommendedProductFilterIdis a product filter id, or00000000feedb10cfeedb10cto show the products this trigger already carries. Shoppable products cannot use that sentinel.EmailTemplateQrCodeSection— A QR code.EmailTemplateScratchToRevealSection— A scratch-to-reveal discount block.EmailTemplateShoppableProductsSection— Shoppable product cards. The template trigger must provide Cart Context.schemaFieldNamedefaults tocartContext.productFilterIdis a product filter id. This block cannot use the trigger-products sentinel.EmailTemplateSocialLink— One social icon and URL.EmailTemplateSocialsSection— Social icons.EmailTemplateSpacerSection— Vertical space.EmailTemplateSubscriptionAddToOrderSection— Add items to a subscription order.EmailTemplateSubscriptionChargeDate— Whether and how the next charge date is shown.EmailTemplateSubscriptionSkipInitialPage— Copy and button on the skip-or-delay landing page.EmailTemplateSubscriptionSkipOption— Whether skipping the next charge is offered.EmailTemplateSubscriptionSkipOrDelaySection— Skip or delay a subscription charge.EmailTemplateSubscriptionSwapProductSection— Swap a subscription product.EmailTemplateTableCellBinding— A{{ }}path on the row alias for a dynamic table cell (item.title).EmailTemplateTableCollection— An event path a DYNAMIC table can bind asrowCollection. Schema fields, not Mongo ids.EmailTemplateTableColumn— One table column definition.EmailTemplateTableImageCell— An image table cell.EmailTemplateTableRow— One static table row.EmailTemplateTableSection— A static or dynamic table.EmailTemplateTableTextCell— A text table cell.EmailTemplateTextSection— A text section.EmailTemplateTitleSubtitle— A title and subtitle pair.EmailTemplateTrackableSummarySection— Order or return summary. The template trigger must provide a Trackable Summary.schemaFieldNamedefaults toorderSummary.customFieldsandvariantMetafieldsare labels under that object, not catalog keys.EmailTemplateTrackingInfoSection— Shipment tracking status. The template trigger must provide a Tracker.schemaFieldNamedefaults totrackerand must be a Tracker key fromemailTemplateVariableCatalog.EmailTemplateTranslation— An email template’s copy in one language.EmailTemplateTranslationEntry— One string in the email’s source language that can be translated.EmailTemplateTranslationText— The translation of one string.EmailTemplateUnknownSection— A stored block this API version does not expose field-by-field.paramsis the rest of the stored JSON.EmailTemplateUrlKey— A camelCase Url / Maybe Url key forschemaFieldNameorclickthroughSchemaFieldNamewhen a button or image uses DYNAMIC_VARIABLE.EmailTemplateVariable— One template variable for subject, preview text, and authored strings. Use{{ name }}.EmailTemplateVariableCatalog— Static trigger grammar for email templates: template variable names, Url keys, context objects, and table collection paths. Same for every store. Does not list discounts, saved sections, or product filters.FreeShippingDiscountSettings— A free-shipping discount.GeneratedDiscountCode(Experimental) — A unique code generated from a discount configuration for one customer or send.MarketingAutomation— A marketing automation: a flow that sends email or SMS to customers when a trigger fires. It can also be one of Redo’s default return-tracking automations (origin: DEFAULT), which the store sees while returns are on and it has no automation of its own for the same trigger.MarketingAutomationAbTestStep— Splits traffic across named variants. Inserting without variants creates A/B at 50/50.MarketingAutomationAbTestVariant— One arm of a weighted split.MarketingAutomationAnalytics— Analytics for this marketing automation. Each field beneath is a separate read against a different store, with its own arguments and its own scope.MarketingAutomationCatalog— What this store can build: the triggers its automation builder offers, the step kinds each one can insert, and the grammar for its trigger-data predicates and triggerSpecificFields. Does not list templates, segments, or strategies; look those up by id. Segment conditions use segmentConditionCatalog.MarketingAutomationCatalogStepKind— A step kind this API models, with the key that carries its fields in aninsertorupdateoperation on updateMarketingAutomation.MarketingAutomationCatalogTrigger— A trigger createMarketingAutomation accepts, and the step kinds an automation on it can insert.MarketingAutomationCommerceAgentChannel— Who a Commerce Agent conversation reaches and on which channel.MarketingAutomationConditionStep— True/false branch. Inserting without nextTrueStepId/nextFalseStepId keeps the previous outgoing edge on true and mints an End on false.MarketingAutomationEndStep— Terminal step. Shoppers stop here.MarketingAutomationEntryCondition— The automation starts only when this trigger-data expression matches. Segments belong on skip conditions, because entry is decided before customer data is loaded.MarketingAutomationEntryConditions— Start the automation only when these trigger-schema predicates match. Null when unset.MarketingAutomationExistingSegmentCondition— Match shoppers who belong to one or more existing segments.MarketingAutomationFrequencyCap— How often a customer may re-enter this automation.MarketingAutomationInlineSegmentCondition— Inline segment rules. The JSON tree matches createDynamicSegment / segmentConditionCatalog.conditionsJsonSchema, with exactly one condition block.MarketingAutomationManageCustomerTagsStep— Adds or removes customer tags.MarketingAutomationManageStaticSegmentStep— Adds or removes the shopper from a static segment.MarketingAutomationMessagingAnalytics— Email and SMS performance for this marketing automation over a date range, at whichever grain you ask for.MarketingAutomationSendEmailStep— Sends an email template by id. Nested template editing is not supported. Insertable only when the trigger schema has an Email field.MarketingAutomationSendSmsStep— Sends an SMS template by id. Nested template editing is not supported. Insertable only when the trigger schema has a Phone field.MarketingAutomationSendWebhookHeader— A webhook header name. The stored value is write-only and is not returned.MarketingAutomationSendWebhookOAuth2Config— OAuth2 client-credentials settings. clientSecret is write-only and is not returned.MarketingAutomationSendWebhookStep— Sends an HTTP webhook. Header values and the OAuth client secret are omitted from reads.MarketingAutomationSkipCondition— Skips matching action steps when the expression matches. Recover offer-response and Recover checkout predicates hydrate as unsupported and are rejected on write.MarketingAutomationSkipConditions— Skip action steps when these conditions match. Null when the trigger has no skip conditions.MarketingAutomationStartAgentConversationStep— Starts a Commerce Agent conversation with the customer. The agent writes the outreach from the step’s Commerce Agent strategy. Skipped at run time when Commerce Agent is disabled.MarketingAutomationStepAnalytics— One step’s sends and engagement over a date range, and the orders credited to it. Orders are credited by the store’s attribution settings to the last marketing or Commerce Agent message before them.MarketingAutomationTriggerDataCondition— Predicate over the trigger schema payload. Recover checkout predicates are not supported.MarketingAutomationTriggerDataElement— Theconditionan ARRAY_PREDICATE applies to each element of a list field.MarketingAutomationTriggerDataField— A trigger-payload field atriggerDatapredicate can match, the same list the automation builder’s condition picker offers.MarketingAutomationTriggerStep— The flow’s single trigger. It cannot be inserted or removed; only patched.MarketingAutomationUnknownStep— A stored step this API version does not expose field-by-field, including recover. Opaque steps cannot be inserted.MarketingAutomationUnsupportedCondition— A stored expression this API cannot write, including Recover offer-response.MarketingAutomationWaitForEventStep— Wait until a customer event arrives, then continue.MarketingAutomationWaitStep— Wait a duration before continuing.MarketingContactSuppression— One contact from a suppress or unsuppress call, and what the call did to it.MarketingEmailSettings— Which addresses the store’s marketing emails come from and send replies to by default. One per store.MarketingImageUpload— A private, one-time place to PUT an image file, so its bytes never pass through the API request.MessageAnalyticsPoint— A marketing send’s analytics for a single day. Days with no activity are omitted rather than reported as zero.MessageAnalyticsTotals— A marketing send’s totals across the whole date range, and the same figures split by channel.MessageChannelAnalytics— One channel’s share of a marketing send’s analytics.MessageDecision(Experimental) — One decision about whether Redo may, or will, message a shopper, and why. Kept for one year.MetafieldProductFilter— Recommends products through a product metafield.OrderLookup— The store’s embedded Shopify order-lookup form configuration.Popup(Experimental) — A storefront popup: a modal, full-screen or panel form shown to shoppers, often to collect email and SMS signups. Views and signups are not here; read them from an analytics report.PopupTrigger— One trigger that shows a popup.ProductFilterCollection— A collection on this account’s connected store. The id is the provider’s collection id, not a Redo product filter id.ProductFilterCollectionConstraint— Keep products that belong to these collections.ProductFilterExcludePurchasedConstraint— Drop products this customer already bought.timeframelimits how far back that purchase history goes.ProductFilterInventoryConstraint— Keep products whose inventory matches the comparison.ProductFilterMetafieldConstraint— Keep products that have one of these metafields.ProductFilterMetafieldDefinition— A product metafield definition from this account’s Shopify Admin API. Key and namespace are what a metafield filter stores.ProductFilterMetafieldRef— A product metafield key in a namespace.ProductFilterPriceConstraint— Keep products whose price matches the comparison.ProductFilterTagConstraint— Keep or drop products based on tags.ProductFilterTimeframe— A duration measured in one unit.ProviderRecommendationsProductFilter— Recommends products using the store provider’s own recommendation API.Segment— A group of customers that campaigns and automations send to.SegmentCatalogActivity— A counted activity kind. Use aseventon a CUSTOMER_ACTIVITY condition.SegmentCatalogCustomEvent— The CUSTOM_EVENT condition shape. Event names are per-store; look them up with segmentTokenFieldOptions.SegmentCatalogField— One field the condition grammar accepts. Generated from the segment data-structure registry.SegmentConditionCatalog— Static grammar for dynamic segment conditions. Same for every store except that some activities are platform-specific. Does not include live tags, products, or customers — those come from segmentTokenFieldOptions.SegmentOperatorSet— Operators valid for one field data type.SegmentTokenFieldOptions— Store-specific values for a catalog field that needs token options.SegmentTokenOption— One allowed value for a token catalog field.SmsKeyword(Experimental) — A word customers text to the store’s number to subscribe to SMS marketing, set under Settings > Keywords.SmsTemplate— The content of an SMS, as the merchant authored it.SmsTemplateImage— An image sent with an SMS template as MMS.TagProductFilter— Recommends products that have these tags.TrackingPage— A merchant order-tracking page that shoppers see when viewing shipment status.TrackingPageMetrics— Opens, clicks, and attributed revenue for a tracking page over a date range.UploadedMarketingImage— An image hosted by Redo, ready to use as an SMS template image or an email image URL.ViewedProductsProductFilter— Recommends products this customer viewed in the window.
Interfaces
MessageAnalytics— Counts and rates for a marketing send over a period. Rates are fractions rather than percentages, and are null when the denominator is zero. Counts cover events that happened inside the range, which for an automation may include engagement with messages sent before it — so a rate can exceed 1.ProductFilter— A named product recommendation rule saved on this account.idis the 24-character hex an email block stores asrecommendedProductFilterIdorproductFilterId. It is not a catalog product id.
Input objects
AmountOffDiscountSettingsInput— A percent-off or amount-off discount.AttributionEvidenceSettingInput— Changes to one kind of evidence. A field you leave out keeps its stored value.AttributionSettingsUpdateInput— Attribution settings to change. Only what you pass changes: leave outdefaultModelto keep the model, and leave out a kind of evidence to keep it as it is. Null is refused everywhere, so leave a field out instead.AttributionWindowInput— An attribution window. At most 30 days, so a value that comes to more fails with BAD_USER_INPUT (400).BackInStockSubscriptionFilter— Which back-in-stock subscriptions to return.BuyXGetYDiscountSettingsInput— A buy-X-get-Y discount.CampaignEmailVariantInput— One email arm to send. Pass an existing template; this does not copy it.CampaignFollowUpInput— Follow-up email settings. Email campaigns only.CampaignSmsVariantInput— One SMS arm to send. Pass an existing template; this does not copy it.CreateCampaignInput— The details of a campaign to create. Email campaigns also need a subject and preview text.CreateCommerceAgentStrategyInput— A new Commerce Agent strategy.CreateCustomerTagInput— Name and provider for a new customer tag. Source is always Redo Marketing.CreateDiscountCodeInput— A discount code to create on Shopify or BigCommerce. Pass amount-off, free-shipping, or buy-X-get-Y settings.CreateDynamicSegmentInput— Name and condition tree for a new dynamic segment. Build the tree from segmentConditionCatalog; look up token values with segmentTokenFieldOptions.CreateEmailTemplateInput— Fields for a new email template.triggeris required and immutable after create. Omit style fields to use builder defaults. Optionaloperationson the mutation populate sections after the default header/line/footer.CreateMarketingAutomationInput— Creates a disabled automation unlessenabledis true. The flow starts as the chosen trigger followed by an end step.dateandprice_droptriggers are not accepted here.CreateMarketingImageUploadInput— The file you will PUT to the upload URL.CreateSampledSegmentInput— The segment to sample, how many members to sample, and the name of the new segment.CreateSmsTemplateInput— Fields for a new SMS template.triggeris required and immutable after create.CreateTrackingPageInput— Name for a new tracking page.CustomerCustomFieldDeclarationCreateInput— Definition for a new customer custom field declaration.DiscountBxgyCustomerBuysInput— The X side of a buy-X-get-Y discount.DiscountBxgyCustomerGetsInput— The Y side of a buy-X-get-Y discount.DiscountCatalogItemInput— A product or collection identified by the platform’s id.DiscountCodeExpirationInput— When the code stops working.DiscountCodeSettingsInput— How the discount reduces the order. Pass exactly one ofamountOff,freeShipping, orbuyXGetY.DiscountCombinesWithInput— Which other discounts this code may stack with.DiscountMinRequirementInput— A minimum purchase required to use the code.EmailDomainCreateInput— A domain to send email from.EmailSenderCreateInput— A new sender address.EmailSenderUpdateInput— Fields to change on a sender address. Omitted fields are unchanged.EmailTemplateBrandKitButtonBorderInput— Brand-kit button border.EmailTemplateBrandKitButtonOverrideInput— Brand-kit button override.EmailTemplateBrandKitEmailButtonInput— Brand-kit styled button fields.EmailTemplateBrandKitFontInput— Brand-kit font.EmailTemplateBrandKitStrokeInput— Brand-kit border stroke.EmailTemplateButtonSectionInput— Fields for a button section. Omitted fields keep their value (update) or the default (insert).EmailTemplateChromeDinoSectionInput— Fields for a Chrome dinosaur section. Omitted fields keep their value (update) or the default (insert).EmailTemplateColumnChildInput— One column slot. Pass exactly one typed payload, or null in the parent list for an empty slot. Nested columns are not allowed.EmailTemplateColumnSectionInput— Fields for a column layout.columnsreplaces the full child list (2–6 slots; null is empty). Omit it to change layout only, or to insert empty slots from columnCount.EmailTemplateDelayOptionInput— A skip-or-delay duration choice.EmailTemplateDiscountSectionInput— Fields for a discount section. Omitted fields keep their value (update) or the default (insert).EmailTemplateFooterSectionInput— Fields for a footer section. Omitted fields keep their value (update) or the default (insert).EmailTemplateHeaderSectionInput— Fields for a header section. Omitted fields keep their value (update) or the default (insert).EmailTemplateHtmlSectionInput— Fields for an HTML section. Omitted fields keep their value (update) or the default (insert).EmailTemplateImageSectionInput— Fields for an image section. Omitted fields keep their value (update) or the default (insert).EmailTemplateInlineButtonInput— Fields for a button inside a products block.EmailTemplateLineSectionInput— Fields for a line section. Omitted fields keep their value (update) or the default (insert).EmailTemplateManualProductInput— A manually chosen product and variant.EmailTemplateMenuItemInput— One menu link. Omit id on insert to mint one.EmailTemplateMenuSectionInput— Fields for a menu section. Omitted fields keep their value (update) or the default (insert).EmailTemplatePaddingInput— Pixel padding on each side. Omitted sides stay unchanged.EmailTemplateProductCardContentInput— Which parts of a shoppable product card are visible.EmailTemplateProductsSectionInput— Products block. Omit a field to keep the merchant default on insert, or the saved value on update. Not a column child.EmailTemplateQrCodeSectionInput— Fields for a QR code section. Omitted fields keep their value (update) or the default (insert).EmailTemplateScratchToRevealSectionInput— Fields for a scratch-to-reveal section. Omitted fields keep their value (update) or the default (insert).EmailTemplateSectionInsertInput— Insert a section. Omit anchors to append at the root. after/before splice next to a root or interactive-review success-section id, not a column child. parent (no index) appends to an interactive-review success section. Column children are set with a completecolumnslist on the column payload. Pass exactly one typed payload.EmailTemplateSectionMoveInput— Move a section relative to a root or interactive-review success-section id. Column children are not valid destinations; replace a column’scolumnslist instead. A column child can still be moved out to the root with after/before on the parent column.EmailTemplateSectionOperation— One surgical edit. Pass exactly one of update, insert, remove, or move.EmailTemplateSectionRemoveInput— Remove a section by id, including nested column children.EmailTemplateSectionUpdateInput— Change one existing section. Pass the section id and exactly one typed payload.EmailTemplateShoppableProductsSectionInput— Shoppable products block. Omit a field to keep the merchant default on insert, or the saved value on update. Not a column child. Cannot use the trigger-products sentinel.EmailTemplateSocialLinkInput— One social icon and URL.EmailTemplateSocialsSectionInput— Fields for a socials section. Omitted fields keep their value (update) or the default (insert).EmailTemplateSpacerSectionInput— Fields for a spacer section. Omitted fields keep their value (update) or the default (insert).EmailTemplateSubscriptionAddToOrderSectionInput— Fields for a subscription add-to-order section. Omitted fields keep their value (update) or the default (insert).EmailTemplateSubscriptionChargeDateInput— Whether and how the next charge date is shown.EmailTemplateSubscriptionSkipInitialPageInput— Copy and button on the skip-or-delay landing page.EmailTemplateSubscriptionSkipOptionInput— Whether skipping the next charge is offered.EmailTemplateSubscriptionSkipOrDelaySectionInput— Fields for a skip-or-delay section. Omitted fields keep their value (update) or the default (insert).EmailTemplateSubscriptionSwapProductSectionInput— Fields for a subscription swap-product section. Omitted fields keep their value (update) or the default (insert).EmailTemplateTableCellInput— Pass image or text, not both.EmailTemplateTableColumnInput— One table column definition.EmailTemplateTableImageCellInput— An image cell.EmailTemplateTableRowInput— One static table row.EmailTemplateTableSectionInput— Fields for a table section. Omitted fields keep their value (update) or the default (insert). Pass image or text on each cell, not both.EmailTemplateTableTextCellInput— A text cell.EmailTemplateTextSectionInput— Fields for a text section. Omitted fields keep their value (update) or the default (insert).EmailTemplateTitleSubtitleInput— A title and subtitle pair.EmailTemplateTrackableSummarySectionInput— Fields for an order-summary section. Omitted fields keep their value (update) or the default (insert). The trigger must provide a Trackable Summary.EmailTemplateTrackingInfoSectionInput— Fields for a tracking-info section. Omitted fields keep their value (update) or the default (insert). The trigger must provide a Tracker; a campaign template is rejected.EmailTemplateTranslationInput— An email template’s copy in one language.EmailTemplateTranslationTextInput— The translation of one source string.FreeShippingDiscountSettingsInput— A free-shipping discount.MarketingAutomationAbTestStepInput— A/B test configuration.MarketingAutomationAbTestVariantInput— One arm of a weighted split.MarketingAutomationCommerceAgentChannelInput— Commerce Agent channel. Sending a channel replaces the stored one. SMS reaches subscribers by default; set extendedOutreach to also reach non-subscribers through Recover (requires Recover). EMAIL takes neither audience field.MarketingAutomationConditionExpressionInput— Pass exactly one of existingSegment, inlineSegment, or triggerData.MarketingAutomationConditionStepInput— Condition configuration. Insert requires expression with exactly one arm.MarketingAutomationEndStepInput— END steps have no configuration besides an optional title.MarketingAutomationEntryConditionInput— One entry condition. expression must be triggerData. Segment membership belongs on skip conditions.MarketingAutomationEntryConditionsInput— Replace the trigger’s entry conditions. An empty conditions list clears them.MarketingAutomationExistingSegmentConditionInput— Existing-segment membership. Requires at least one segmentId.MarketingAutomationFrequencyCapInput— Re-entry cap for the trigger.MarketingAutomationInlineSegmentConditionInput— Inline segment rules. conditions must match segmentConditionCatalog.conditionsJsonSchema with exactly one condition block.MarketingAutomationManageCustomerTagsStepInput— Customer-tag action. Insert requires at least one tagId.MarketingAutomationManageStaticSegmentStepInput— Static-segment action. Insert requires segmentId.MarketingAutomationSendEmailStepInput— Send-email configuration. Insert requires templateId or originTemplateId. Nested template editing is not supported.MarketingAutomationSendSmsStepInput— Send-SMS configuration. Insert requires templateId. Nested template editing is not supported.MarketingAutomationSendWebhookHeaderInput— One webhook header. value is required because sending headers replaces the stored list.MarketingAutomationSendWebhookOAuth2ConfigInput— OAuth2 client-credentials settings. Omit clientSecret on update to keep the stored secret.MarketingAutomationSendWebhookStepInput— Send-webhook configuration. Insert requires an http or https destinationUrl and a payload. Sending headers replaces the whole list, and each header must include its value. clientSecret is write-only: omit it on update to keep the stored secret.MarketingAutomationSkipConditionInput— One skip condition. expression is exactly one of existingSegment, inlineSegment, or triggerData.MarketingAutomationSkipConditionsInput— Replace the trigger’s skip conditions. An empty conditions list clears them.MarketingAutomationStartAgentConversationStepInput— Start a Commerce Agent conversation. Insert requires strategyId (create one withcreateCommerceAgentStrategy); channel defaults to SMS subscribers.MarketingAutomationStepInsertInput— Insert a step. Pass after (parent) or before (existing child), not both. A/B parents require variantId. Condition parents require branch TRUE or FALSE. Pass exactly one typed payload. Which payloads the automation’s trigger accepts is listed per trigger in marketingAutomationCatalog; any other returns STEP_NOT_INSERTABLE.MarketingAutomationStepMoveInput— Move a step onto another outgoing edge. Same after/before/variantId/branch rules as insert.MarketingAutomationStepOperation— One surgical edit. Pass exactly one of update, insert, remove, or move.MarketingAutomationStepRemoveInput— Remove a step by id. The trigger cannot be removed.MarketingAutomationStepUpdateInput— Change one existing step. Pass the step id and exactly one typed payload.MarketingAutomationTriggerDataConditionInput— Trigger-schema predicate. Build it from marketingAutomationCatalogtriggerDataFieldsandpredicateJsonSchemafor this automation’s trigger. Recover checkout predicates are rejected. HSA/FSA cart eligibility is allowed.MarketingAutomationTriggerStepInput— Patch the trigger. key, schemaType, and category cannot be changed.MarketingAutomationWaitForEventStepInput— Wait-for-event configuration.MarketingAutomationWaitStepInput— Wait-step configuration. Insert defaults to 1 day.MarketingEmailSettingsUpdateInput— Defaults to change. Omitted fields are unchanged.MarketingImageSourceInput— The image file to upload. Set exactly one field.ProductFilterConstraintInput— One extra condition. Set the fields fortypeand leave the others unset.ProductFilterInput— A product filter to save. Set the fields forrecommendationTypeand leave the others unset.ProductFilterMetafieldInput— A product metafield key in a namespace.ProductFilterTimeframeInput— A duration measured in one unit.SmsKeywordCreateInput— The keyword text and the tags it applies. A new keyword is active.SmsKeywordUpdateInput— The fields to change on a keyword. Omitted fields are kept.UpdateCampaignInput— Fields to change on a campaign. Omitted fields are left unchanged.segmentIds,excludedSegmentIds,emailVariants,smsVariants, andtagsreplace the whole list.UpdateCommerceAgentStrategyInput— Fields to change on a Commerce Agent strategy. Omitted fields are unchanged.goalGuidanceandoutreachGuidanceare staged in the strategy’sdraftand go live when you publish it;nameanddiscountCodeIdchange the strategy at once. Null or an empty string clears guidance; null removes the discount code.UpdateCustomerTagInput— Fields to change on a customer tag.UpdateDiscountCodeInput— Fields to change on a discount code. Omitted fields are left unchanged.settingsreplaces the whole configuration.UpdateDynamicSegmentInput— Fields to change on a dynamic segment. Omit a field to leave it unchanged.UpdateEmailTemplateInput— Metadata fields to change. Omit a field to leave it unchanged. Section edits go inoperations, not here.UpdateMarketingAutomationInput— Metadata fields to change. Omit a field to leave it unchanged. Step edits go inoperations, not here.UpdateSmsTemplateInput— Fields to change. Omit a field to leave it unchanged.triggercannot be changed after create.UpdateTrackingPageInput— Fields to update on a tracking page. Omit a field to leave it unchanged.UploadMarketingImageInput— An image to compress and host for a marketing template.
Enums
AttributionEvidenceType— Something that suggests a message caused an order. A message earns credit when at least one kind of evidence on it is switched on and falls inside its window.AttributionModel— How an order’s credit is split among the messages that earned it.AttributionWindowUnit— The unit of an attribution window.BackInStockSubscriptionStatus— Whether a back-in-stock subscriber is still waiting.CampaignErrorCode— Why a campaign failed to send.CampaignFollowUpEngagementPeriod— How long after the original send to look for engagement.CampaignSendBlocker— Something that stops a campaign from being sent.CampaignSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.CampaignStatus— Where a campaign is in its send lifecycle.CustomerCustomFieldDataType— The value type stored by a customer custom field.CustomerCustomFieldDeclarationSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.CustomerTagProvider— Who has authority to add or remove this tag on a customer. Synced Shopify tags use SHOPIFY.CustomerTagSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.CustomerTagSource— Where this tag was created. Independent ofprovider.DiscountBxgyTriggerType— What the customer must buy to unlock the Y items.DiscountCodeExpirationInputType— When a newly created or updated discount code should stop working.DiscountCodeExpirationType— When a discount code stops working.DiscountCodeGroupType— Whether the merchant set one fixed code or a code generated per customer.DiscountCodeKind— How the discount reduces the order.DiscountCodeProvider— The commerce platform that hosts this discount code.DiscountCodeSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.DiscountCustomerEligibility— Which customers may use the code.DiscountDynamicRangeExpirationUnit— The unit for how long a minted unique code stays valid after it is generated.DiscountMinRequirementType— How a minimum purchase requirement is measured.DiscountPurchaseType— Whether the code applies to one-time purchases, subscriptions, or both.DiscountValueType— Whether an amount-off is a percent or a currency amount.EmailDomainDkimStatus— Whether the email provider has verified the domain’s DKIM key.EmailDomainDnsRecordKind— What a DNS record does for a sending domain.EmailDomainDnsRecordStatus— What Redo found when it last looked the record up in DNS.EmailDomainDnsRecordType— A DNS record type.EmailDomainMailFromStatus— Whether the email provider has verified the domain’s MAIL FROM domain.EmailDomainSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.EmailSenderSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.EmailTemplateAlignment— Horizontal alignment of a section.EmailTemplateBrandKitFontWeight— Brand-kit font weight.EmailTemplateBuilderFontWeight— Bold vs regular text in table cells.EmailTemplateButtonHierarchy— Brand-kit button hierarchy.EmailTemplateButtonLinkType— How a button or image clickthrough is resolved at send time.EmailTemplateCartLayoutType— Row or column layout for a products block.EmailTemplateDelayTimeUnit— Delay option unit for skip-or-delay.EmailTemplateHeaderTextTransform— Letter case for order-summary section headers.EmailTemplateHeaderType— Which header treatment to render.EmailTemplateImageSize— Line-item image size on an order summary.EmailTemplateLocale— A language an email template can be written or translated into.EmailTemplateObjectFit— How a line-item image fills its box.EmailTemplateProductSelectionType— How a products block chooses which products to show.EmailTemplateScratchToRevealScratcherSize— Size of the scratch-to-reveal cursor.EmailTemplateSectionKind— The stored block type of an email template section.EmailTemplateShoppableProductsSize— Card size for a shoppable products block.EmailTemplateSocialIconColor— Social icon color treatment.EmailTemplateSocialItemSource— Where a social URL came from.EmailTemplateSocialPlatform— A social network icon.EmailTemplateSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.EmailTemplateSpacingSize— Named padding size used by image, line, and footer blocks.EmailTemplateSubscriptionDateFormat— How a subscription charge date is shown.EmailTemplateTableBorderStyle— Table border style.EmailTemplateTableCellType— Image or text table cell.EmailTemplateTableColumnWidthMode— How a table column width is computed.EmailTemplateTableMobileStacking— How table columns stack on small screens.EmailTemplateTableMode— Static grid vs event-driven rows.EmailTemplateTableVerticalAlignment— Cell vertical alignment. MIDDLE maps to MJML middle, not center.EmailTemplateTranslationEntryKind— Whether a translatable string is plain text or HTML.EmailTemplateTranslationField— Where in the email a translatable string lives, so it can be labeled.EmailTemplateVariableSource— Where a template variable comes from. Trigger fields come from the template’s schema; renderer names are filled for every email; non-schema names resolve from the store or customer at send time.EmailTemplateVerticalAlignment— Vertical alignment of column children.GeneratedDiscountCodeSource(Experimental) — The Redo feature that generated a discount code.GeneratedDiscountCodeStatus(Experimental) — Whether a generated discount code can still be used.MarketingAudience— Who a marketing message reached: shoppers who subscribed to marketing, or shoppers who didn’t and were texted only after a person reviewed the message.MarketingAutomationCategory— Which trigger family a marketing automation belongs to. Every category here can send email or SMS; the category is copied from the automation’s trigger.MarketingAutomationChannel(Experimental) — A channel a marketing automation sends on, from the kinds of steps it has.MarketingAutomationCommerceAgentChannelKind— The channel a Commerce Agent conversation starts on.MarketingAutomationConditionBranch— Which outgoing arm of a condition parent to attach to.MarketingAutomationConditionConjunction— How a list of trigger conditions is combined.MarketingAutomationFrequencyCapMode— How often a customer may re-enter this automation.MarketingAutomationOrigin(Experimental) — Who made a marketing automation.MarketingAutomationSkipActionType— Which action steps a skip condition applies to. Omit the list to apply to every action.MarketingAutomationSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.MarketingAutomationStepKind— The stored step type of a marketing automation node. UNKNOWN is any type this API version does not model field-by-field, including recover.MarketingAutomationTagOperation— Whether to add or remove tags or static-segment membership.MarketingAutomationTriggerExpressionType— Thetypea trigger-data predicate on a field must have. Stored as the lowercase value. predicateJsonSchema has each shape.MarketingAutomationWaitTimeUnit— Unit for wait durations and frequency-cap cooldowns.MarketingAutomationWebhookAuthType— How a send-webhook step authenticates.MarketingChannel— The channel a marketing message is delivered over.MarketingContactSuppressionOutcome— What a suppress or unsuppress call did to one contact.MarketingEmailReplyToWarning— Why customer replies to the default Reply-To address may not be received.MarketingTrigger— The public name for stored schemaType. Determines which variables and dynamic links apply. Namedtriggerin this API, notschemaType.MessageDecisionDefinitionKind— What a message decision belongs to.MessageDecisionOutcome— Which way a message decision went.MessageDecisionReason— Why a message decision went the way it did.PopupSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.PopupStatus— Whether a popup is published to the storefront.PopupTarget— Which visitors a popup is shown to.PopupTriggerKind— What shows a popup to a shopper.PopupType— How a popup is laid out on desktop, from its first step.ProductBackInStockNotifyOutcome— What a back-in-stock notify call did.ProductFilterComparison— Comparison for a price or inventory constraint.ProductFilterConstraintType— Which constraint this input is.ProductFilterMetafieldStorefrontAccess— Whether Shopify exposes this product metafield definition on the storefront.ProductFilterProvider— Store connection a product filter or its collection catalog uses. Credentials always come from this account’s saved integration.ProductFilterRecommendationType— How a saved product filter chooses products.ProductFilterSort— Order of products a filter returns.ProductFilterTagOperator— Whether a tag constraint includes or excludes the tags.ProductFilterTimeUnit— Unit for a viewed-product or added-to-cart window.SegmentCatalogSource— Which platform an activity is recorded on. Pick the source that matches the store.SegmentConditionCategory— Merchant-facing grouping for catalog fields and activities.SegmentConditionKind— The three condition shapes a dynamic segment tree accepts.SegmentConjunction— How condition blocks, or conditions inside a block, combine.SegmentFieldDataType— Comparison shape for a catalog field. Stored on the condition aswhereCondition.type.SegmentFieldUnit— Presentational unit for a numeric field. The stored value is a bare number.SegmentSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.SegmentType— How membership of a segment is determined.SmsKeywordSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.SmsKeywordStatus— Whether texting this keyword subscribes the sender.SmsTemplateSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.TrackingPageSortKey— A field this list can be ordered by; pass to the list’sorderByargument and pair withreverseto flip direction.