Enums overview | DoSwiftly Docs

📄️ AttributeBillingMode

How an option surcharge is billed: BUNDLED (added into the product price — a single line) or SEPARATE_LINE (shown as its own order line, which may carry its own tax rate).

Who provides the value: MERCHANT (set by the seller — product metadata, not shown as an editable field), CUSTOMER (entered or chosen by the shopper in the configurator), or BOTH (seller sets a default the shopper can change).

📄️ AttributeOptionSurchargeType

Surcharge calculation: FIXED (minor units) or PERCENT (thousandths of percent)

📄️ AttributeOptionsSearchSort

Sort order for attributeOptionsSearch results

📄️ AttributeType

Type of product attribute

📄️ BlogPostSortKey

Sort keys for blog posts

📄️ BlogPostStatus

Status of a blog post

📄️ BrandSortKeys

Sort keys for the brands() query

📄️ CartStatus

Cart lifecycle status. ACTIVE and RECOVERED are editable carts. ABANDONED flags a cart the buyer left inactive (used for recovery campaigns) — it is not locked: a deliberate buyer action revives it in place to RECOVERED and the mutation proceeds. RECOVERED is a previously-abandoned cart the buyer came back to (via a recovery link or by acting on it again). CONVERTED carries an associated completedOrder; query that to redirect the buyer to their order confirmation, since editing a converted cart returns CartErrorCode.ALREADYCOMPLETED. EXPIRED is past its lifetime with no order; editing it returns CartErrorCode.CARTNOT_FOUND — create a fresh cart.

📄️ CartWarningCode

Stable, machine-readable codes for non-fatal cart warnings. The mutation succeeded; the storefront can surface a toast or stay silent based on the code.

📄️ CollectionSortKeys

Sort keys for collections

📄️ CompensationType

Type of compensation for the return

📄️ ConfiguratorConditionOperator

How a visibility rule compares against the referenced field. EQUALS / ONE_OF with optionIds the field shows when NONE is selected.

📄️ ContentFormat

Format of stored content. Content is always served as ready-to-render HTML via content(format:).

📄️ CountryCode

ISO 3166-1 alpha-2 country code (2-letter uppercase, e.g. PL, DE, US), plus XK (Kosovo). ZZ means the stored country is not a recognised code.

📄️ CropRegion

Region to crop the image

📄️ CurrencyCode

ISO 4217 currency code (3-letter uppercase, e.g. PLN, EUR, USD).

📄️ CurrencyRateSource

Source of exchange rate data

📄️ CurrencySymbolPosition

Whether the currency symbol renders before or after the amount.

📄️ CustomerAccountStatus

Account state right after signup. ACTIVE — the buyer is signed in (customerAccessToken present). PENDING_APPROVAL — the store verifies new accounts manually; no token is issued and login is refused until the store approves the account (show pendingApprovalMessage).

📄️ CustomerType

Customer profile type — INDIVIDUAL (B2C buyer) or COMPANY (B2B buyer). Drives which company fields are required and which appear on tax documents.

📄️ DeliveryType

Delivery destination type of a shipping method — signals whether the storefront must collect a pickup point.

📄️ DiscountApplicationType

Category of discount: PERCENTAGE (percent off), FIXEDAMOUNT (amount off), FREESHIPPING (zeroes shipping) or BUYXGET_Y (item-quantity-based).

📄️ DiscountErrorCode

Stable reasons why a discount code is not applicable to the current cart / customer.

📄️ EmailMarketingState

Email marketing consent state of a customer. NOT_SUBSCRIBED = never opted in. PENDING = single opt-in awaiting double opt-in confirmation. SUBSCRIBED = active opt-in. UNSUBSCRIBED = explicitly opted out. REDACTED = data erased on request. INVALID = email rejected (bounce / spam complaint).

📄️ FilterPresentation

Filter presentation hint

📄️ FilterType

Type of filter

📄️ FormFieldType

Input control of a store-defined form field. Raw submitted values are strings: CHECKBOX sends "true"/"false", NUMBER a decimal string, MULTI_SELECT uses the values list.

📄️ FormSectionRequirement

Whether a built-in registration section (company / address / phone) is hidden, shown as optional, or required by the store.

📄️ GiftCardErrorCode

Gift card validation error codes

📄️ GiftCardStatus

Gift card status

📄️ ImageContentType

Image content type for output format

📄️ LanguageCode

ISO 639-1 language code (2-letter uppercase, e.g. PL, EN, DE).

📄️ LanguageDirection

Text direction for the language

📄️ LocationType

Type of inventory location (warehouse, physical store, etc.)

📄️ LoyaltyTierType

Loyalty program tier level

📄️ LoyaltyTransactionType

Type of loyalty points transaction

📄️ MarketingOptInLevel

Email marketing opt-in level — SINGLE_OPT_IN, CONFIRMED_OPT_IN, UNKNOWN.

📄️ MenuItemType

Menu item link type

📄️ NodeType

Type discriminator for node()/nodes() queries (the UUID does not contain a type prefix)

📄️ OrderFulfillmentStatus

Fulfillment progress of an order. UNFULFILLED → PARTIALLY_FULFILLED → FULFILLED (items shipped) → IN_TRANSIT → DELIVERED. PARTIALLY_RETURNED / RETURNED reflect post-delivery returns; LOST marks a parcel that never reached the buyer.

📄️ OrderPaymentStatus

Payment status of an order. UNPAID = no payment recorded yet; PENDING = initiated, awaiting confirmation; AUTHORIZED = held but not captured; PAID = fully paid; PARTIALLY_PAID / PARTIALLY_REFUNDED = intermediate states; REFUNDED = fully refunded; FAILED, CHARGEBACK, VOIDED, REFUND_PENDING = terminal / in-flight unpaid states.

📄️ PageSortKeys

Sort keys for pages

📄️ PaymentAcknowledgementDocumentKind

Category of a document linked from an acknowledgement statement (TERMS, INFORMATION_OBLIGATION, PRIVACY_POLICY). Use for optional iconography; the token is what binds the link into the statement text.

📄️ PaymentAcknowledgementEnforcement

Whether collecting a payment acknowledgement in the storefront is optional (GATEWAY_FALLBACK — the gateway shows it itself when you omit it) or mandatory (STOREFRONT_REQUIRED — paymentCreate rejects with ACKNOWLEDGEMENT_REQUIRED unless the buyer accepted it).

📄️ PaymentInitiationFlow

How the storefront should launch the payment after paymentCreate. ONLINE_REDIRECT = redirect the browser to redirectUrl. ONLINE_EMBEDDED = render an in-page widget using clientSecret. INSTANT_DIRECT = the payment is already settled, check status. OFFLINE_MANUAL never appears here — when the order uses an offline method canCreatePayment is false and paymentCreate is not called.

📄️ PaymentInstrumentDisplayHint

UX rendering hint for a payment instrument — the storefront can switch between prominent button / branded tile / dropdown / radio per hint. Backend-agnostic mapping to visual treatment.

📄️ PaymentInstrumentType

Classifies a concrete instrument within a PaymentMethod (BLIK code vs bank vs wallet vs card brand). Storefront-facing typing for per-instrument UI dispatch.

📄️ PaymentMethodType

Category of a payment method (CARD / BLIK / BANK_TRANSFER / INSTALLMENT / WALLET / CASH_ON_DELIVERY / OTHER). Drives iconography and copy in the payment picker; do not branch on provider directly — use this type instead.

📄️ PaymentMethodUnavailableReason

Why a payment method is currently unavailable. GATEWAY_DOWN/DISABLED/NO_INSTRUMENTS are transient (gateway-side); CREDENTIALS_INVALID needs merchant action in the admin panel.

📄️ PaymentProvider

Canonical payment provider identifier (UPPERCASE per GraphQL convention). Used for Order.paymentProvider, Payment.provider, PaymentMethod.provider, PaymentMethod.providersAvailable, PaymentMethod.preferredProvider and CartSelectPaymentMethodInput.preferredProvider. The set of gateways a shop can use is configurable — the values listed here are the providers the platform currently supports.

📄️ PaymentWarningCode

Machine-readable code for PaymentWarning.code. Non-blocking signals from payment mutations — branch on this to dispatch UI retry hints. INSTRUMENTCLEAREDFOR_RETRY indicates backend auto-cleared a preselected payment instrument after gateway rejection; next paymentCreate will land on the gateway default page.

📄️ PickupSelectionMode

How the buyer selects a pickup point for a shipping method that requires one.

📄️ ProductOptionInputType

Storefront rendering hint for a product option — SELECT (dropdown), COLOR_SWATCH (colored tiles), or TEXT (free text).

📄️ ProductSortKeys

Sort keys for products

📄️ ProductTypeEnum

Product type classification. PHYSICAL = ships to an address (requires the shipping step). DIGITAL = delivered electronically. SERVICE = booking / appointment, no shipment. SUBSCRIPTION = recurring billing. GIFT_CARD = issues a redeemable card on completion.

📄️ ProductVisibility

Catalog placement — PUBLIC | HIDDEN | BUNDLE_ONLY

📄️ RecommendationIntent

Type of product recommendations to return

📄️ RecommendationType

Type of product recommendation

📄️ ReturnReason

Reason for returning an item

📄️ ReturnStatus

Status of a return request

📄️ ReviewSortKey

No description

📄️ RichTextFormat

Representation to return for a rich-text field. HTML is ready-to-render markup (default). TEXT is plain text, for content previews, snippets, and search indexing (for SEO meta tags use the dedicated seo fields). JSON is the structured document, for building your own renderer.