Objects overview | DoSwiftly Docs

📄️ AttributeFilterValueConnection

Paginated + searchable attribute options (Relay Connection)

📄️ AttributeFilterValueEdge

Edge in AttributeFilterValueConnection (Relay spec)

📄️ AttributeFilterValue

Attribute filter value with product count

A configurator selection that the buyer filled in on a line item — typed snapshot taken at add-to-cart and frozen on the resulting order. Distinct from CartLine.attributes (free-form key/value line item properties): selections are validated against the product attribute definition, carry pricing surcharges and can link to a hidden component variant.

📄️ AttributeSwatch

Color or pattern swatch for visual attribute display

📄️ Attribute

A generic key/value attribute — used for line item properties and other free-form metadata.

📄️ AvailableFilters

Available filters for product listing

📄️ AvailablePaymentMethods

Result of availablePaymentMethods — the methods to render in the payment picker plus the merchant default.

📄️ AvailableShippingMethod

A shipping method offered to the buyer for the current cart and destination — what to render in the shipping picker.

📄️ AvailableShippingMethodsPayload

Result of availableShippingMethods / cart.availableShippingMethods — the methods to render plus optional free-shipping progress and any user errors.

📄️ AvailableShippingRatesPayload

Live carrier shipping rates payload

📄️ B2BPriceDisplay

Complete B2B price display information

📄️ B2BVariantPricing

B2B pricing for a product variant

📄️ BankTransferInstructions

Everything the buyer needs to pay for an order by manual bank transfer — render it on the confirmation page for orders where paymentMethodType is BANK_TRANSFER and canCreatePayment is false. Reflects the merchant's CURRENT bank account details (not a snapshot), so a returning buyer always sees the account that is valid right now.

📄️ BlogAuthor

Blog post author

📄️ BlogCategory

Blog category

📄️ BlogPostConnection

Paginated blog posts

📄️ BlogPostEdge

Blog post edge

📄️ BlogPost

Blog post

📄️ BlogTag

Blog tag

📄️ BotProtectionInfo

Bot protection configuration (platform-level)

📄️ BotProtectionProviderInfo

Single bot protection provider config

📄️ BrandColorGroup

Single brand color group (background + foreground hex)

📄️ BrandColors

Pair of brand color groups (primary + secondary)

📄️ BrandConnection

Paginated brand connection

📄️ BrandEdge

Brand edge for pagination

📄️ BrandFilterValue

Brand filter value with product count

📄️ Brand

Canonical product brand entity (e.g. Funko, Nike). Distinct from ShopBrand (shop branding metadata).

📄️ BusinessHour

Business hours for a day

📄️ BusinessHoursWindow

Opening window for a business day (24h format)

📄️ BusinessHours

Per-day business hours (BOPIS). Missing day = closed.

📄️ CarrierRateError

Provider error when fetching rates

📄️ CarrierShippingRate

Live shipping rate from a carrier

📄️ CartAddLinesPayload

Result of cartAddLines.

📄️ CartAppliedGiftCard

A gift card that the buyer has attached to the cart. The card is debited when the cart completes.

📄️ CartApplyGiftCardPayload

Result of cartApplyGiftCard.

📄️ CartAttribute

Custom attribute on a cart line — free-form key/value used for line item properties such as engraving text or gift wrap flags.

📄️ CartBuyerIdentity

Buyer identity attached to the cart — email, phone, locale hints used during checkout and on the resulting order.

📄️ CartClearPaymentSelectionPayload

Result of cartClearPaymentSelection. cart is populated on success with cleared selection fields (selectedPaymentMethod === null, selectedPaymentInstrument === null). userErrors is populated when the cart is locked (CONVERTED status → ALREADY_COMPLETED code).

📄️ CartCompletePayload

Result of cartComplete. The cart is converted into an Order and locked — no further mutations are accepted on it. Payment is initiated separately via paymentCreate (after checking order.canCreatePayment).

📄️ CartCost

Cart cost breakdown. All amounts are in the buyer preferred currency (auto-converted when the shop runs multi-currency). total is what the buyer will pay at checkout — no need to recompute.

📄️ CartCreatePayload

Result of cartCreate.

📄️ CartDiscountAllocation

Per-code discount amount applied to the cart. Sum these for the aggregate total — or read CartCost.totalDiscount.

📄️ CartDiscountCode

A discount code that the buyer has attached to the cart.

📄️ CartDiscountCodesUpdatePayload

Result of cartDiscountCodesUpdate.

📄️ CartDowngradeOnLogoutPayload

Result of cartDowngradeOnLogout.

📄️ CartFeeAllocation

A single fee charged on the cart, with the reason it applies. Sum these for the aggregate — or read CartCost.feeTotal.

📄️ CartLineConnection

Paginated list of cart lines (Relay Connection).

📄️ CartLineCost

Cost breakdown for a single cart line.

📄️ CartLineEdge

Edge in a CartLine connection

📄️ CartLine

A single line item in the cart — one variant, a quantity and the data attached to it (cost, attributes, configurator selections).

📄️ CartMergePayload

Result of cartMerge.

📄️ CartRecommendations

Recommendations based on cart contents

📄️ CartRecoveryRedeemPayload

Result of cartRecoveryRedeem.

📄️ CartRemoveGiftCardPayload

Result of cartRemoveGiftCard.

📄️ CartRemoveLinesPayload

Result of cartRemoveLines.

📄️ CartSelectPaymentMethodPayload

Result of cartSelectPaymentMethod.

📄️ CartSelectShippingMethodPayload

Result of cartSelectShippingMethod.

📄️ CartSetBillingAddressPayload

Result of cartSetBillingAddress.

📄️ CartSetShippingAddressPayload

Result of cartSetShippingAddress.

📄️ CartShippingMethod

The shipping method currently selected on a cart, with its display label and cost.

📄️ CartUpdateAttributesPayload

Result of cartUpdateAttributes.

📄️ CartUpdateBuyerIdentityPayload

Result of cartUpdateBuyerIdentity.

📄️ CartUpdateGiftCardRecipientPayload

Result of cartUpdateGiftCardRecipient.

📄️ CartUpdateLinesPayload

Result of cartUpdateLines.

📄️ CartUpdateNotePayload

Result of cartUpdateNote.

📄️ CartWarning

Cart warning (non-fatal advisory)

📄️ Cart

A shopping cart — the buyer-facing aggregate that holds items, totals, buyer identity, addresses, selected shipping and payment methods, gift cards and discount codes through to checkout completion.

📄️ CategoryConnection

Paginated category list (Relay Connection)

📄️ CategoryEdge

Category edge in connection

📄️ CategoryFilterOption

Category filter option

📄️ Category

Product category - hierarchical organization

📄️ CollectionConnection

Paginated collection connection

📄️ CollectionEdge

Collection edge for pagination

📄️ Collection

Collection - curated group of products

📄️ ConfiguratorFieldCondition

A visibility rule of a configurator field. Rules combine with AND — render the field only when every rule is met against the shopper’s current selections. When hidden, clear its value; the server rejects selections for hidden fields.

📄️ ConfiguratorField

A single field of a product configurator — an input the shopper sees on the product page.

📄️ ConfiguratorOptionPrice

Surcharge of a single configurator choice served through the authenticated price channel — use when the store restricts catalog prices to signed-in customers (ConfiguratorOption.surchargeAmount is null in the public catalog then). Options mapped to a stocked variant are priced via variantPrices instead.

📄️ ConfiguratorOption

A selectable choice within a product configurator field (e.g. a size, finish or add-on).

📄️ ConvertedPriceRange

Price range in converted currency

📄️ Country

A country supported by the shop (ISO 3166-1 alpha-2)

📄️ CurrencyConversion

Currency conversion result

📄️ Currency

Currency information

📄️ CustomerAccessToken

Access token returned by customerLogin, customerSignup and customerRefreshToken. Send it on subsequent requests in the Authorization: Bearer header, or store it in an HTTP-only cookie via the SDK BFF helpers. Never write it to localStorage.

📄️ CustomerActivatePayload

Result of customerActivateByUrl mutation — admin-created customer sets initial password

📄️ CustomerAddAddressPayload

Result of address creation

📄️ CustomerGroup

Customer group for B2B pricing

📄️ CustomerLoginPayload

Result of customerLogin.

📄️ CustomerLogoutPayload

Result of customerLogout — invalidates the current access token on the server.

📄️ CustomerRefreshTokenPayload

Result of customerRefreshToken — exchanges a valid current token for a fresh one with a later expiry.

📄️ CustomerRemoveAddressPayload

Result of address deletion

📄️ CustomerRequestPasswordResetPayload

Result of password recovery

📄️ CustomerResendVerificationEmailPayload

Result of customerResendVerificationEmail — queues a fresh verification e-mail for the signed-in customer.

📄️ CustomerResetPasswordPayload

Result of customerResetByUrl mutation — password reset via signed URL

📄️ CustomerSetDefaultAddressPayload

Result of default address update

📄️ CustomerSignupPayload

Result of customerSignup.

📄️ CustomerUpdateAddressPayload

Result of address update

📄️ CustomerUpdatePayload

Result of customer update

📄️ CustomerVerifyEmailPayload

Result of customerVerifyEmail — confirms the e-mail address using the one-shot token from the verification e-mail.

📄️ Customer

A registered customer of the shop — identity, profile, B2B fields, saved addresses and order history. Returned by customer (currently authenticated) and customerSignup.

📄️ DeliveryEstimate

Estimated delivery window for a shipping method, in business days.

📄️ DigitalDownloadLinkPayload

Result of issuing a download link for digital content.

📄️ DigitalDownloadLink

A single-use link for downloading digital content.

📄️ DigitalDownload

Digital content bought together with an order line item.

📄️ DiscountInfo

Details of a discount that the buyer entered and that is currently valid for the cart.

📄️ DiscountValidationError

Reason why a discount code is not valid for the current cart / customer.

📄️ DiscountValidationResult

Result of validating a discount code against a cart — preview only, no cart side effects.

📄️ Domain

Shop domain (host, full URL, SSL state)

📄️ EntityAttributeField

Attribute assignment per entity (polymorphic owner)

📄️ ExchangeRate

Exchange rate between currencies

📄️ FilterValue

Filter value with product count

📄️ Filter

Faceted filter for product listing

📄️ FormFieldOption

Selectable choice of a SELECT / MULTI_SELECT form field.

📄️ FormSubmitPayload

Result of formSubmit.

📄️ FreeShippingProgress

Progress towards the free shipping threshold configured by the merchant — drives "Add X more to get free shipping" banners.

📄️ GenerateReferralCodePayload

Result of generating referral code

📄️ GiftCardError

Gift card validation error

📄️ GiftCardLineRecipient

Recipient details attached to a GIFT_CARD line — set with cartUpdateGiftCardRecipient. All fields are nullable individually so a partial set (e.g. email only) is representable.

📄️ GiftCardValidatePayload

Result of gift card validation

📄️ GiftCardValidation

Gift card validation result

📄️ GiftCard

Gift card information

📄️ ImageConnection

Paginated list of images (Relay Connection)

📄️ ImageEdge

Edge in an Image connection

📄️ Image

An image with its URL and presentation metadata. The URL accepts an Image.url(transform: ...) argument for responsive resizing / format selection.

📄️ Language

Language configuration

📄️ LinkedVariantSummary

Summary of the stocked ProductVariant a configurator option maps to (component-style choice). Exposed via ConfiguratorOption.linkedVariant.

📄️ LocaleCurrencyMapping

Locale to currency mapping entry

📄️ Localization

Localization context for the storefront

📄️ LocationAddress

Physical address of a location

📄️ LocationConnection

Paginated location connection

📄️ LocationEdge

Edge in a paginated Location connection

📄️ Location

Inventory location (warehouse, store, pickup point)

📄️ LoyaltyAction

Available point earning action

📄️ LoyaltyMember

Loyalty program member

📄️ LoyaltyPageInfo

Page info

📄️ LoyaltyPointsSummary

Loyalty points summary

📄️ LoyaltyReward

Redeemable loyalty reward

📄️ LoyaltySettings

Public loyalty program settings

📄️ LoyaltyTier

Loyalty program tier

📄️ LoyaltyTransactionConnection

Paginated loyalty transactions

📄️ LoyaltyTransactionEdge

Loyalty transaction edge

📄️ LoyaltyTransaction

Loyalty points transaction

📄️ MailingAddressConnection

Paginated list of mailing addresses (Relay Connection).

📄️ MailingAddressEdge

Edge in a MailingAddress connection

📄️ MailingAddress

A mailing address — shipping or billing — used on a cart, on the resulting order, or saved in a customer address book. Carries optional B2B fields (taxId, vatNumber, regon) and an optional pickupPoint for parcel locker / collection-point delivery.

📄️ MenuItem

Navigation menu item

📄️ Menu

Navigation menu

📄️ Money

A monetary amount with its ISO 4217 currency code.

📄️ NewsletterIncentive

The shop's newsletter signup incentive — when enabled, a confirmed newsletter signup earns a personal discount code delivered by email. Use this to render the signup banner with real campaign values (e.g. "-10%" or "-20 PLN"); when isEnabled is false, hide the incentive messaging entirely.

📄️ OrderConnection

Paginated order connection

📄️ OrderDiscountAllocation

Per-code discount applied to an order. Mirrors a cart discount allocation; the sum across allocations equals the order-level discount.

📄️ OrderEdge

Order edge for pagination

📄️ OrderFeeAllocation

A single fee charged on the order, frozen at checkout. Mirrors a cart fee allocation; the sum across allocations equals OrderTotals.feeTotal.

📄️ OrderLineItemConnection

Paginated order line items (Relay Connection)

📄️ OrderLineItemEdge

Order line item edge

📄️ OrderLineItem

Order line item with variant snapshot and live enrichment

📄️ OrderTotals

Cost totals on an order — symmetric with CartCost so the confirmation page renders the same breakdown the buyer saw at checkout.

📄️ Order

A buyer order — the result of completing a cart. Carries totals, status, addresses, line items and the signals needed to drive payment (canCreatePayment, paymentMethodType) and a guest confirmation page (accessToken).

📄️ PageInfo

Cursor pagination info for a Relay Connection.

📄️ PaymentAcknowledgementDocument

A document linked from a payment acknowledgement statement. Its token matches a … tag inside PaymentAcknowledgement.statement — wrap the tagged words in an anchor to url (open in a new tab). Never inject the statement as raw HTML.

📄️ PaymentAcknowledgement

A consent the buyer can affirm before paying with this method (e.g. the Przelewy24 regulation declaration). Render statement as a checkbox label — the checkbox MUST NOT be pre-checked — with the … tagged words linked to the matching documents[].url. On submit, echo the accepted codes back via PaymentCreateInput.acknowledgements. When enforcement is GATEWAY_FALLBACK collecting it is optional (the gateway shows it otherwise); STOREFRONT_REQUIRED must be accepted or paymentCreate returns ACKNOWLEDGEMENT_REQUIRED.

📄️ PaymentCreatePayload

Result of paymentCreate.

📄️ PaymentInstrument

A single concrete instrument exposed by a gateway provider (e.g. BLIK code, mBank Pay-By-Link, Apple Pay) within a broader PaymentMethod. Pass code as preferredInstrument in cartSelectPaymentMethod to deep-link the gateway straight to this screen.

📄️ PaymentMethodFee

Surcharge preview for choosing this payment option — render it on the picker tile (e.g. "+5 zł") BEFORE the buyer selects anything. Populated only on Cart.availablePaymentMethods (a percentage fee is computed from the value of this cart); always null on the shop-level Query.availablePaymentMethods. The amount and label match the CartCost.feeAllocations row that appears after selection, so the tile and the summary can never disagree.

📄️ PaymentMethod

A payment method offered to the buyer at checkout — what to render in the payment picker and pass to cartSelectPaymentMethod.

📄️ PaymentSession

Payment session created for an order. Branch on flow to launch payment: ONLINE_REDIRECT → redirect to redirectUrl; ONLINE_EMBEDDED → render an in-page widget using clientSecret; INSTANT_DIRECT → the payment is already settled, check status.

📄️ PaymentSettings

Shop payment configuration (currency, country, providers)

📄️ PaymentWarning

Non-blocking signal emitted alongside userErrors — backend state change context (e.g. an auto-clear, a server-side adjustment) that the storefront may surface as a retry hint or analytics event. Always pre-translated by backend per shop locale.

📄️ PickupPoint

A pickup point (parcel locker or staffed collection point) attached to a delivery address. The buyer picks it in the carrier widget; it is persisted on the cart shipping address and carried through to the order.

📄️ PointsEstimate

Points estimate for an order

📄️ PredictiveSearchResult

Predictive search result for typeahead UI

📄️ PriceMoney

Price with full conversion transparency

📄️ PriceRange

Price range for filtering

📄️ PriceReductionInfo

Statutory reference of an announced price reduction (EU price-indication rules): the lowest price the variant was sold at during the 30 days before the current cut, plus the data needed to display it correctly. Present only while the variant is reduced and the reference can be proven.

📄️ PricingTier

Quantity-based pricing tier

📄️ ProductAttachment

A file publicly attached to a product (manual, certificate, warranty card).

📄️ ProductConnection

Paginated product list

📄️ ProductEdge

Product edge for pagination

📄️ ProductOptionValue

Product option value

📄️ ProductOption

Product option

📄️ ProductPriceRange

Original price range in shop base currency

📄️ ProductRecommendation

Single product recommendation with metadata

📄️ ProductRecommendations

Collection of product recommendations

📄️ ProductReviewConnection

Paginated reviews connection

📄️ ProductReviewEdge

Review edge for pagination

📄️ ProductReview

Product review

📄️ ProductVariantConnection

Paginated list of product variants (Relay Connection)

📄️ ProductVariantEdge

Edge in a ProductVariant connection

📄️ ProductVariant

A purchasable unit of a product — one variant out of the product variants list, identified by its id and described by its options.

📄️ Product

Product - main catalog item

📄️ RedeemRewardPayload

Result of reward redemption

📄️ ReferralStats

Referral program statistics

📄️ RegistrationFormConfig

Registration form configuration of the store — built-in sections plus store-defined custom fields. Render the sections and fields, then pass the collected values to customerSignup.

📄️ ReturnCancelPayload

Result of return cancellation

📄️ ReturnConnection

Paginated return connection

📄️ ReturnCreatePayload

Result of return creation

📄️ ReturnEdge

Return edge for pagination

📄️ ReturnItemPhoto

Photo evidence for a return item

📄️ ReturnItem

Item included in a return request

📄️ ReturnPayload

Result of return query

📄️ ReturnReasonOption

Return reason option for UI

📄️ ReturnShippingLabel

Return shipping label

📄️ Return

Return/RMA request

📄️ ReviewPayload

Review mutation payload

📄️ ReviewStats

Product review statistics

📄️ SearchQuerySuggestion

Predictive search query suggestion (typeahead)

📄️ SelectedOption

One option of a product variant — e.g. { name "Large" }.

📄️ SEO

SEO metadata

📄️ ShipmentEdge

Shipment edge for pagination

📄️ ShipmentEvent

Shipment tracking event

📄️ ShipmentItem

Item included in a shipment

📄️ ShipmentPackage

Package dimensions and weight

📄️ ShipmentPayload

Result of shipment query

📄️ Shipment

Order shipment with tracking information

📄️ ShippingCarrier

Shipping carrier associated with a shipping method (e.g. InPost, DPD, DHL).

📄️ ShippingPickupConfig

Pickup-point selection config for a shipping method whose deliveryType is LOCKER or PICKUP_POINT. Contains ONLY public, browser-safe data — for InPost this is the domain-scoped Geowidget token, never the ShipX API secret. Use it to render the carrier map (selectionMode = WIDGET) or to drive a server-side point search (selectionMode = SEARCH).

📄️ AttributeDefinition