Marketing

​

Queries

• 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, or when they finished sending.
• commerceAgentStrategies — Commerce Agent strategies on this store, newest first, optionally filtered by name. At most 100 are returned; narrow with query to reach older ones.
• commerceAgentStrategy — Look up a Commerce Agent strategy by id. Returns null when this store has no strategy with that id.
• 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.
• 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.
• marketingAutomation — Fetch a single marketing automation by its id. Ids from earlier versions of the Redo API are also accepted.
• marketingAutomations — List marketing automations, optionally filtered by name, category, or whether they are running.
• 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 for conditions. 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.
• 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.

​

Mutations

• cancelCampaign — Stop an in-progress campaign. Returns null if no campaign with that id is owned by the caller.
• createCampaign — Create a campaign shell. Email requires subject and previewText. Set the audience and schedule with updateCampaign.
• createCommerceAgentStrategy — Create a Commerce Agent strategy. Set its id as strategyId when 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. trigger is required and cannot be UNKNOWN. Optional operations are applied to the default sections.
• createMarketingAutomation — Create an automation for a public trigger. Returns the new automation. Date and price-drop triggers are not supported.
• createProductFilter — Save a product filter on this account. The returned id is what an email block stores.
• createSmsTemplate — Create an SMS template. trigger is required and cannot be UNKNOWN.
• 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.
• updateCampaign — Update a campaign. Returns null if no campaign with that id is owned by the caller.
• updateCommerceAgentStrategy — Update a Commerce Agent strategy. 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. Pass input, operations, or both.
• updateMarketingAutomation — Update automation metadata and/or apply step operations. Returns null if no owned automation matches the id. Pass input, operations, or both.
• 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.
• 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.
• CampaignSmsVariant — One version of a campaign’s SMS content, with the share of recipients it was sent to.
• 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.
• 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.
• 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. section is null when the merchant left the slot empty.
• EmailTemplateContextObject — A structured trigger field blocks bind through schemaFieldName (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.
• EmailTemplateManualProduct — A product chosen by hand. productId and variantId are 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. schemaFieldName defaults to cartContext. recommendedProductFilterId is a product filter id, or 00000000feedb10cfeedb10c to 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. schemaFieldName defaults to cartContext. productFilterId is 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 as rowCollection. 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. schemaFieldName defaults to orderSummary. customFields and variantMetafields are labels under that object, not catalog keys.
• EmailTemplateTrackingInfoSection — Shipment tracking status. The template trigger must provide a Tracker. schemaFieldName defaults to tracker and must be a Tracker key from emailTemplateVariableCatalog.
• EmailTemplateUnknownSection — A stored block this API version does not expose field-by-field. params is the rest of the stored JSON.
• EmailTemplateUrlKey — A camelCase Url / Maybe Url key for schemaFieldName or clickthroughSchemaFieldName when 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.
• MarketingAutomation — A marketing automation: a flow that sends email or SMS to customers when a trigger fires.
• 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.
• 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.
• MarketingAutomationTriggerDataCondition — Predicate over the trigger schema payload. Recover checkout predicates are not supported.
• 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.
• 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.
• MetafieldProductFilter — Recommends products through a product metafield.
• 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. timeframe limits 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 as event on 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.
• 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.
• 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. id is the 24-character hex an email block stores as recommendedProductFilterId or productFilterId. It is not a catalog product id.

​

Input objects

• AmountOffDiscountSettingsInput — A percent-off or amount-off discount.
• 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. trigger is required and immutable after create. Omit style fields to use builder defaults. Optional operations on the mutation populate sections after the default header/line/footer.
• CreateMarketingAutomationInput — Creates a disabled automation unless enabled is true. The flow starts as the chosen trigger followed by an end step. date and price_drop triggers are not accepted here.
• CreateSmsTemplateInput — Fields for a new SMS template. trigger is required and immutable after create.
• 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 of amountOff, freeShipping, or buyXGetY.
• DiscountCombinesWithInput — Which other discounts this code may stack with.
• DiscountMinRequirementInput — A minimum purchase required to use the code.
• 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. columns replaces 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 complete columns list 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’s columns list 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.
• 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 with createCommerceAgentStrategy); 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. Send email/SMS require matching fields on the trigger schema.
• 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. 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.
• MarketingImageSourceInput — The image file to upload. Set exactly one field.
• ProductFilterConstraintInput — One extra condition. Set the fields for type and leave the others unset.
• ProductFilterInput — A product filter to save. Set the fields for recommendationType and leave the others unset.
• ProductFilterMetafieldInput — A product metafield key in a namespace.
• ProductFilterTimeframeInput — A duration measured in one unit.
• UpdateCampaignInput — Fields to change on a campaign. Omitted fields are left unchanged. segmentIds, excludedSegmentIds, emailVariants, smsVariants, and tags replace the whole list.
• UpdateCommerceAgentStrategyInput — Fields to change on a Commerce Agent strategy. Omitted fields are unchanged. 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. settings replaces 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 in operations, not here.
• UpdateMarketingAutomationInput — Metadata fields to change. Omit a field to leave it unchanged. Step edits go in operations, not here.
• UpdateSmsTemplateInput — Fields to change. Omit a field to leave it unchanged. trigger cannot be changed after create.
• UploadMarketingImageInput — An image to compress and host for a marketing template.

​

Enums

• CampaignErrorCode — Why a campaign failed to send.
• CampaignFollowUpEngagementPeriod — How long after the original send to look for engagement.
• CampaignSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• CampaignStatus — Where a campaign is in its send lifecycle.
• 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’s orderBy argument and pair with reverse to flip direction.
• CustomerTagSource — Where this tag was created. Independent of provider.
• 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’s orderBy argument and pair with reverse to 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.
• EmailSenderSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to 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.
• 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’s orderBy argument and pair with reverse to 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.
• 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.
• 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.
• 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.
• 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’s orderBy argument and pair with reverse to 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.
• 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.
• MarketingTrigger — The public name for stored schemaType. Determines which variables and dynamic links apply. Named trigger in this API, not schemaType.
• 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 as whereCondition.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’s orderBy argument and pair with reverse to flip direction.
• SegmentType — How membership of a segment is determined.
• SmsTemplateSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.