Types
Every TypeScript type of the storefront starter, grouped by folder. Open a type to see its fields, comments and the types it uses.
accounts
IApiDateTimeFormatted backend date/time representation.IApiPaginationBackend pagination state.IApiPaginationRequestRequested page and page size.IAuthOtpResendRequestResend a sign-in or registration code.IAuthOtpResendResponseDelivery channel and resend delay.ICaptchaResponseSession CAPTCHA image.IContactRequestContact-form fields.ICustomerMutationResponseSuccess returns `page_data: null`; there is no additional result object.IEmailEnrollRequestTwo-step email verification request.IEmailEnrollResponseNext email-verification step or completion.IEmailNotificationLocaleRequestEmail notification language change.IEmailNotificationLocaleResponseSaved email notification language.IProfileAvatarRequestThe user uploads an image for their own avatar.IProfileAvatarResponseProfile image upload response.IProfileDataCurrent customer profile.IProfileDeleteRequestThe customer deletes their own account. The session ends.IProfileEventRequestThe user registers to participate in an active storefront promotion.IProfileLogOne successful authentication log record.IProfileLogsRequestList successful sign-in records for the current customer, including the recorded browser and device information.IProfileLogsResponse`page_data.data` contains authentication history records; `rpag` contains pagination.IProfileNotificationSettingOne available email notification type and its current setting.IProfileNotificationSettingsRequestSettings for individual email notification types or all optional notifications.IProfileNotificationSettingsResponseCurrent email notification settings after loading or saving.IProfilePasswordRequestThe user changes their own password. The current session is preserved.IProfileRequestReturns the current user’s personal profile and email notification preference.IProfileResponse`page_data.profile_info` is an array, normally containing one customer profile. It can be empty when filters do not match.IProfileSearchHistoryRequestFind visible saved search phrases belonging to the current customer.IProfileSearchHistoryResponse`page_data.data` contains search records and `page_data.rpag` describes pagination. Empty results contain an empty `data` array.IProfileSearchUpdateRequestThe application adds the submitted phrases to the current user’s search history.IProfileSearchUpdateResponse`page_data.added_updated` counts processed phrases that were added or refreshed. It is not necessarily the number of distinct new records.IProfileUpdateRequestThe user changes their own first name, last name, birth date and email notification language.IStorefrontProfileActionDiscriminated account action emitted by a profile form.IStorefrontProfileStateHost-owned account presentation state; not a backend response.IUnsubscribeRequestEmail-link token and subscription type to cancel.
address
IAddressCitySuggestionCity suggestion and optional postal code from the country plugin.IAddressCitySuggestionRequestRequired location and text fields for suggestion lookup, at the JSON root.IAddressCitySuggestionResponseSuggestion response envelope with results or API errors.IAddressCountryCountry in a saved address or the shipping-country list.IAddressCountryOptionCountry option in the address form.IAddressLocationSuggestionAddress suggestion returned by the geocoding service, with nullable address fields.IAddressLocationSuggestionRequestRequired longitude and latitude at the JSON root for address lookup.IAddressLocationSuggestionResponseAddress lookup response envelope with suggestions or API errors.IAddressRegionA region with translated names and its country identifiers.IAddressRegionLocaleA translated region name for one locale.IAddressRegionSearchFiltersOptional region name, country ID and ordering filters.IAddressRegionSearchRequestJSON request body for region search.IAddressRegionSearchResponseRegion search response envelope with results or API errors.IAddressSuggestionStreet suggestion and optional postal code from the country plugin.IAddressSuggestionRequestRequired location and text fields for suggestion lookup, at the JSON root.IAddressSuggestionResponseSuggestion response envelope with results or API errors.IUserAddressSaved customer address.IUserAddressDeleteResponse`page_data` is either `null` or an object with `another_default`.IUserAddressListRequestOptional address search conditions.IUserAddressListResponse`page_data` contains separate `addresses` and `countries` arrays. Address country/region values are objects, while write requests use their IDs.IUserAddressRequestAddress fields for creation and full update.IUserAddressSaveResponseOn success, `page_data` is an array containing the saved address. Read `page_data[0]` for its ID and normalized values.IUserAddressShippingRequestChange the default shipping flag.IUserAddressShippingResponseSuccess returns a message with `page_data: null`. This method does not return a refreshed address list.
apiBase
TMethodHTTP methods supported by an endpoint.
appBase
IAppLoadInitial storefront data, customer profile and available API endpoints.IAppLoadCommonShared storefront settings and initial content.IAppLoadCommonBannerBanner images for different screen sizes.IAppLoadCommonContactCompany contact details and legal information.IAppLoadCommonCurrencyCurrency symbols, conversion value and selection settings.IAppLoadCommonCurrencyLocaleLocalized currency name.IAppLoadCommonEventsPromotional content and its display settings.IAppLoadCommonLocaleStorefront language and its default currency and units.IAppLoadCommonLocaleNameLocalized language name.IAppLoadCommonLogosStorefront logos and favicon.IAppLoadCommonSeoLocalized metadata for the store home page.IAppLoadCommonSeoLocaleHome-page title, description and keywords in one language.IAppLoadCommonSocialSocial link, icon and localized label.IAppLoadCommonSocialLocaleLocalized title and caption of a social link.IAppLoadCommonTariffInitial tariff choices and subscription information.IAppLoadCommonUnitMeasurement unit, conversion value and localized names.IAppLoadCommonUnitLocaleLocalized unit name and abbreviation.IAppLoadCommonVariablesCart and wishlist counters and storefront feature defaults.IAppLoadCommonVisualSettingsCatalog layout and storefront display preferences.IAppLoadCommonWalletValueCustomer wallet amount expressed in a currency.IAppLoadPathEndpoint name, URL, supported methods and request forms.IAppLoadPathObjectResource groups and the endpoints within them.IAppLoadPathsRecordAPI discovery grouped by resource.IApploadUserProfileProfile of the signed-in customer.IDomainSeoOgA home-page Open Graph property and its localized content.IDomainSeoTwitterA home-page Twitter Card metadata tag and its localized content.IFormRequest form with action fields and filters.IFormFieldOne request field: input type, validation and available choices.IFormFieldsNamed request fields and nested field groups.ISeoOgCategory Open Graph metadata with record and category identifiers.ISeoOgLocaleLocalized content of an Open Graph property.ISeoTwitterCategory Twitter Card metadata with record and category identifiers.ITwitterLocaleLocalized content of a social card meta tag.TBannerFormatsAvailable banner image formats.TEventsFormatAvailable event image formats.
blog
EBlogAccessTypeBlog access mode.EBlogCommentStatusBlog comment moderation state.EBlogPublishingStateBlog publication state.EBlogViewTypeBlog preview layout modes.IBlogCategoryPublic blog category.IBlogCommentCustomer-visible blog comment.IBlogCommentCreateRequestSend `for_post`, optional `parent` and `text` at the JSON root.IBlogCommentEditRequestPut `comment_id` in the URL and send the complete new `text` at the root. Post and parent cannot be changed here.IBlogCommentRemovalResponseThe response returns only the deleted ID.IBlogCommentResponseThe response contains the updated comment in the owned format.IBlogCommentsRequestSend criteria under `filters` and paging under `paginate`. Root comments and replies are separate list requests.IBlogCommentsResponse`page_data.data` contains comments without nested replies. `page_data.rpag` contains pagination data.IBlogPostBlog preview or full article.IBlogPostPreviewBlog publication preview fields consumed by the storefront.IBlogPostsRequestSend conditions in `filters` and paging in `paginate`.IBlogPostsResponseThe response has a paginated `posts` block and a separate category tree. Full-only fields are conditional.IBlogReadingDataPremium reading counters.IBlogReadingRequestSend only `post` at the JSON root. Elapsed seconds, user IDs and session IDs are not input fields. The sandbox sends one request per Send.IBlogReadingResponse`page_data` reports bounded reading counters, not the article body or a monetary reward.IMyBlogCommentsRequestSend criteria under `filters` and paging under `paginate`. Root comments and replies are separate list requests.
cart
DeliveryMapFactoryCreates a delivery map.ECartPromoNoticeReasonReasons of a cart promo notice.ECartStateCart selection and checkout states.EPromoProductDiscountCompatibility with product discounts.EPromoTypePromotion calculation types.ICarrierBoxDelivery box dimensions and limits.ICartAddressAddress snapshot in the cart.ICartAddressLocationCart address coordinates.ICartAddressRequestOwned saved address ID.ICartCheckoutProductProduct assigned to a checkout delivery group.ICartCommentRequestCart comment, or empty text to clear it.ICartContactCart customer or receiver contact.ICartDeliveryCheckout delivery group.ICartDeliveryDataSelected delivery and its current change indicator.ICartDeliveryPointNormalized pickup point.ICartDeliveryPointsRequestOptional provider page number; support and defaults depend on the carrier plugin.ICartDeliveryPointsResponseField or general errors.ICartDeliveryPricesDelivery-group product, option and delivery amounts.ICartDeliverySelectionRequestCheckout group and delivery method IDs.ICartDeliverySelectionResponseField or general errors.ICartDeliveryTypesRequestDelivery-type selection conditions; pagination is not used.ICartDeliveryTypesResponseDelivery-method selection response.ICartGetRequestSend `{}` for the complete cart; no fields are required.ICartGetResponseFull cart with checkout-dependent content.ICartItemMutationResponseCart-item mutation result.ICartLinePricesMain and additional item amounts without delivery.ICartModalResponseCart-preview products with detailed cart quantities and amounts.ICartOptionSelectable product inside a cart option group.ICartOptionDataResponseField or general errors.ICartOptionGroupCart option group with text, file or product choices.ICartOptionPricesOption-product price fields.ICartOptionQuantityRequestNew total quantity of this option; use zero to deselect it. Negative values are rejected.ICartOptionTypeOption type metadata.ICartOptionUploadRequestJSON serialized into the multipart data field.ICartPaymentRequestEligible payment-method ID.ICartPickupSelectionRequestPoint object from `cart_customer_delivery_points_get`. Its `code`, `city_code` and `address` are used when the corresponding root fields below are empty.ICartPreviewStateState of the cart preview: whether it is open or loading, its products and the removals in progress.ICartPricesCurrent cart totals.ICartPromoNoticePromo code without a discount, or a removed or refused code.ICartQuantityRequestSet a product’s total cart quantity.ICartReceiverRequestValid receiver phone number. Use international format to avoid dependence on a configured default region.ICartStateRequestRequested cart state.ICartStateResponseCart-state change result.ICartStoreStore details with cart-specific delivery choices.ICartSummaryCurrent cart state, totals, address and payment choices.ICategoryDirectoryEntryCategory information in product search results and promotion selections.ICurrencyAmountsConverted values keyed by currency ID.IDeliveryMapMarkerDelivery map marker.IDeliveryMapOptionsSettings passed to the map provider.IDeliveryMapPositionMap coordinates.IDeliveryMapViewControls of a created map.IDeliveryTypePublic delivery tariff.IPaymentMethodPublic payment-method details.IPromoDefinitionCustomer-facing promotion definition.IUnitValuesConverted measurement values keyed by unit ID.
catalog
ICatalogLoadResponseCategory tree in `tree`, childless category IDs in `childfree`, and all returned category IDs in `unique_ids`.IManufacturerManufacturer record for the public directory.IManufacturerIndexGroupLetter, total count and manufacturer previews.IManufacturerIndexRequestGet nonempty manufacturer letter groups with a preview of manufacturers in each group.IManufacturerIndexResponse`page_data` is an array of letter groups. Each contains at most 42 manufacturer previews even when the group count is larger.IManufacturerIndexStateManufacturer index loading state.IManufacturerSearchRequestSearch manufacturer records, browse one letter group or load a manufacturer by ID.IManufacturerSearchResponseResults are nested under `page_data.manufactures`: `data` contains records and `rpag` contains pagination.TManufacturerAlphabetIndex alphabet: Latin, Cyrillic or digits.
category
ICategoryCatalog category, localized content and child categories.ICategoryLocaleCategory text, page metadata and banner in one language.
domains
IDomainStore associated with a subscription and its extra options.IDomainExtrasPrice and duration of an additional subscription option.
forms
ICustomerSubfilterOptionOption label and submitted value, with source-specific data.ICustomerSubfilterRequestCustomer form option-reload request.ICustomerSubfilterResponseCustomer option-loader response envelope.
marketing
EPromoUsageLimitSpecial promo usage limits.ICartPromoApplyRefusalData of a refused promo code.ICartPromoRequestCart promo-code request.IPromoIssueCode issued to a customer.IPromoIssuesRequestIssued promo-code list request.IPromoIssuesResponseIssued promo-code list response.
orders
EOrderPaymentStatusOrder state or list grouping.EOrderStatusOrder state or list grouping.EOrderTabOrder state or list grouping.EPreorderStatePreorder processing state.IOrderA customer order with payment, contact details and shipments.IOrderCreatedCreated order and optional payment navigation.IOrderCreateFailureRecovery details accompanying an order creation error.IOrderCreateResponseCreated order and payment link, or error details for restoring checkout.IOrderDeliveryMethodDelivery type and carrier-origin connection metadata.IOrderDigitalAttachmentPurchased digital text or a file attached to an order line.IOrderDigitalFileRequestSend `attached_stock` at the JSON root. Success returns binary file content.IOrderFileErrorResponseJSON error envelope instead of a requested file.IOrderFileResponseSuccessful responses use `application/octet-stream` and an attachment filename. API failures remain JSON envelopes; check the HTTP status and content type before saving.IOrderHistoryRequestOrder filters and pagination.IOrderHistoryResponseCustomer orders with payment totals and nested shipments.IOrderItemRefundStatsReturn/refund counters for one purchased line or option.IOrderLinePricesShipment-line product and option totals by currency.IOrderOptionAn additional product purchased through an option group.IOrderOptionFileRequestSend `option_group` at the JSON root. Success returns binary file content.IOrderOptionGroupA purchased option group with entered text, uploaded file and selected additional products.IOrderOptionPricesPurchased additional-product totals by currency.IOrderPaymentMethodsResponse`page_data` is a dictionary of `IPaymentMethod` records keyed by method ID.IOrderPaymentRequestSend `order` and `payment` at the JSON root. The amount comes from the order’s unpaid balance.IOrderPaymentResponseRead `link` and `link_type` together. An empty link with null type is valid for methods without an external payment page.IOrderPricesOrder totals, payments and refunds by currency.IOrderRefundStatsOrder or shipment return/refund counters.IOrderRepeatRequestSend the owned `order` ID at the JSON root. No new order is submitted by this method.IOrderShipmentOne shipment with its delivery destination and purchased lines.IOrderShipmentAddressSaved order address with country/region arrays for the shipment branch.IOrderShipmentItemOne purchased product line in a shipment.IOrderShipmentPricesShipment totals and delivery/refund amounts by currency.IProductPreorderRequestProduct, optional guest contact details and currency.IProductPreorderResponseNew preorder ID, product, captured USD price and state.OrderRefundWindowReturn request a delivered line accepts now: 'regular' or 'defect'.
payments
EInvoiceStatusBackend invoice status.EPaymentLinkTypePayment-page display mode.IInvoiceCustomer invoice.IInvoiceCreateRequestWallet-invoice creation request.IInvoiceCreateResponseField or general errors.IInvoiceDirectionInvoice funds direction.IInvoicePaymentMethodsRequestPayment-method selection criteria.IInvoicePaymentMethodsResponseField or general errors.IInvoiceRefundRefund of a customer payment.IInvoiceResponseField or general errors.IInvoicesRequestInvoice selection criteria within the current account.IInvoicesResponseField or general errors.
products
EProductFeedbackStatusReview status: `EProductFeedbackStatus.DENIED`, `EProductFeedbackStatus.PENDING` or `EProductFeedbackStatus.APROOVED`.EProductStatusProduct availability states.IAppLoadProductApplication Load product data with a seller reference.IMyProductFeedbacksResponsePaginated reviews in `page_data.feedbacks`.IProcessingProductProduct identifier and the storefront collection being updated.IProductProduct details, prices, images and available variants.IProductAttributeGroup of product characteristics with their names and values.IProductAttributeNameOne product characteristic and its localized value.IProductCartCountsProduct quantity and prices for its cart position.IProductDimensionsProduct length, width and height.IProductFeedbackCustomer review, rating and attached images.IProductFeedbackCountersResponseReaction and reply counters of one approved review; `total_c_aprooved_replies` repeats `total_c_approved_replies` under its old spelling.IProductFeedbackCreateRequestSend `multipart/form-data`: `data` is the JSON object shown in the request; selected files are separate `feedback_images` parts. Do not set a manual multipart boundary.IProductFeedbackCreateResponseThe response contains the moderation `state` and a `feedback` array containing the saved review. Creation also returns its `id` separately.IProductFeedbackDateReview creation date, time and relative-time values.IProductFeedbackEditRequestSend `multipart/form-data`: `data` is the JSON object shown in the request; selected files are separate `feedback_images` parts. Do not set a manual multipart boundary.IProductFeedbackEditResponseModeration state and the saved review; an edited review goes through moderation again.IProductFeedbackImageIdentifier and URL of an image attached to a product review.IProductFeedbackImagesRequestPlace optional criteria in `filters`; page settings belong in `paginate`. Empty filters select all eligible images.IProductFeedbackImagesResponseRead image records from `page_data.data`, with pagination in `page_data.rpag`. Only images from approved reviews left in this store group are returned.IProductFeedbackListRequestPlace selection criteria in `filters` and page settings in `paginate`. Empty filters are allowed.IProductFeedbackListResponsePaginated reviews in `page_data.feedbacks`.IProductFeedbackPreloadRequestSend `reply_id` at the JSON root: the ID of your own review or reply. A missing or unknown ID returns a field error.IProductFeedbackPreloadResponse`page_data` is your review. Someone else’s review returns the error “Feedback was not found.”IProductFeedbackReactionRequestSend `feedback` and boolean `like_or_dislike` at the JSON root.IProductFeedbackReactionResponseUpdated `likes` and `dislikes` counters.IProductFeedbacksProduct review collections, pagination and summary statistics.IProductFeedbackStatProduct review count and average rating from the approved reviews of this storefront’s store group, as in the public review list.IProductFeedbackUserPublic author data returned with a product review.IProductFlagsProduct badges such as new, popular or limited stock.IProductImagesProduct-image URLs grouped by eligibility for small previews.IProductLocaleProduct text and page metadata in one language.IProductManufactureProduct manufacturer and brand images.IProductPaginationCurrent page, result counts and navigation availability.IProductRefundsReturn periods for ordinary and defective products.IProductRelatedRelated product collection.IProductReviewProduct review, author, attachments and discussion state.IProductReviewImageApproved review image and its owning review.IProductSearchChoicesRelated choices for the current product selection.IProductSearchFacetsSearch options and counts returned in selects and variants.IProductSearchFiltersProduct search filters. Selected colors, sizes and other variants are sent in `variant_*`.IProductSearchRangesMinimum and maximum prices and dimensions in available currencies/units.IProductSearchRequestProduct search criteria, dynamic variant choices and pagination.IProductSearchResponseProducts on the current page are in `page_data.products.data`; page details are in `page_data.products.rpag`.IProductSearchSellerSeller fields from product search used to fill preorder permission on a product.IProductSecondaryVariantProduct matched to a secondary variation value.IProductSecondaryVariantInfoSecondary variant property: its type, localized name and whether it is a color.IProductSecondaryVariantRequestParameters for loading secondary choices for the selected primary value.IProductSecondaryVariantsSecondary variation choices and matching products.IProductSecondaryVariantsRequestSend `product_group` and `main_variant_value` at the JSON root. The product lookup below only supplies these choices and is not included in the request.IProductSecondaryVariantsResponse`page_data.secondary` describes the secondary type; `variants` pairs each value with its product record.IProductSecondaryVariantStateLoading state and response for one group of secondary choices.IProductSecondaryVariantValueLocalized secondary variation value and color.IProductSellerPublic seller details shown with a product.IProductsListNamesNames of product collections used by the storefront.IProductSpecificationGroupA named group of product characteristics shown together on the product page.IProductSpecificationRowOne characteristic of a product: its name, its value and the address the value opens.IProductStatusProduct availability code and display label.IProductVariantPrimary variant property: its type, localized name and available values.IProductVariantFilterOne variant type and its available value choices.IProductVariantsMain variation used to select a product.IProductVariantValueOne selectable variation value and its display details.IProductVideoProduct video and its preview image.IWishlistAddRequestAdd a product to the customer’s wishlist.IWishlistAddResponseWishlist addition result and current count.IWishlistRemoveResponseWishlist removal result and current count.ProductFacetSelectionSelected ID arrays keyed by search filter name.
sellers
ISellerDirectoryEntryPublic seller profile in the directory.ISellerDirectoryFiltersSeller directory filter values edited by SellerFilters.ISellerDirectoryImageApproved seller image.ISellerDirectoryRequestPublic seller directory filters.ISellerDirectoryResponseSeller directory response.
state
AppLoadLoaderAsync function that loads an Application Load result.AppLoadStatusInitialization states from idle to success or failure.
stores
IPhysicalStorePublic physical-store information.IPhysicalStoreLocationPhysical-store coordinates.IStoreDirectoryRequestSearch the physical-store directory.IStoreDirectoryResponsePhysical-store records and pagination.IStoreOpeningHoursOne weekday’s opening hours.
subscribeOptions
ISubscribeOptionSubscription option with localized details.ISubscribeOptionLocaleLocalized subscription option name and description.
subscribes
ICustomerSubscriptionOwned customer subscription.ICustomerSubscriptionRenewalRenewal length and price of a subscription.ICustomerSubscriptionRenewalPartsRenewal price split into plan and option.ICustomerSubscriptionRenewalTotalRenewal price as one amount.ICustomerSubscriptionsResponseField or general errors.IPublicSubscriptionExtended customer-facing translations.ISubscribeSubscription offering and its availability settings.ISubscribeLocaleLocalized subscription name and description.ISubscribeTranslationsTranslation values supplied with a subscription.ISubscribeUserDataCustomer subscription data grouped by headings and hosts.ISubscribeUserDataValueTabs within one group of customer subscription data.ISubscriptionCancelRequestThe subscription whose automatic renewal is stopped.ISubscriptionChangeOptionRequestFields sent to move a subscription to another service option.ISubscriptionChangeRequestEither change request: the plan change or the service option change.ISubscriptionChangeTariffRequestFields sent to move a subscription to another plan.ISubscriptionCreateRequestNew subscription request.ISubscriptionRenewalSettingRequestRenewal-setting request.ISubscriptionRenewRequestAdditional paid-period request.ISubscriptionSummaryCustomer-facing subscription summary.ISubscriptionTariffsRequestOptional tariff search conditions.ISubscriptionTariffsResponseField or general errors.
subscribeTariff
ISubscribeTariffTariff pricing, trial period and included options.ISubscribeTariffImagesSmall and full-size tariff illustrations.ISubscribeTariffLocalesTariff name, description and page metadata in one language.ISubscribeTariffOptionTariff option, trial eligibility and period surcharges.ISubscribeTariffPriceTariff price and duration for a billing period.ISubscribeTariffVideoPlan video, preview image and display order.ITariffSelectionTariff selection with a paid or trial period.ITariffSubscribeRequestFields for creating a subscription through subscriptions_subscribe.
tickets
ECustomerTicketSolutionCustomer support and return state.ECustomerTicketStatusCustomer support and return state.ECustomerTicketTypeCustomer support and return state.EOrderRefundShipmentStatusCustomer support and return state.ETicketReplyDirectionCustomer support and return state.ICustomerTicketA customer support conversation with state, counters and purchase references.ICustomerTicketCreatedResponse`page_data` contains the ticket. Read its conversation with `customer_tickets_reply_getall`.ICustomerTicketCreateRequestSend `multipart/form-data`: a `data` part contains the JSON fields, and repeated `ticket_images` parts contain files.ICustomerTicketImageResponseImage bytes with `Content-Type: image/jpeg`. A missing image or an image outside the user’s tickets returns HTTP 404 with the plain-text body `Not found`.ICustomerTicketOrderItemRequestSend `multipart/form-data`: a `data` part contains the JSON fields, and repeated `ticket_images` parts contain files.ICustomerTicketOrderOptionRequestSend `multipart/form-data`: a `data` part contains the JSON fields, and repeated `ticket_images` parts contain files.ICustomerTicketRatingRequestPut `ticket_id` in the URL and `rating` at the JSON root.ICustomerTicketRefundRead-only return shipment, tracking and optional related order.ICustomerTicketRepliesPageRequestSend the owned ticket ID under `filters.ticket`; put page controls in `paginate`.ICustomerTicketRepliesPageResponse`page_data.data` is the current page; `rpag` describes pagination.ICustomerTicketRepliesRequestSend the owned ticket ID under `filters.ticket`. Pagination is ignored by this endpoint.ICustomerTicketRepliesResponseAll ticket messages after adding the reply.ICustomerTicketReplyOne customer or support message and its image references.ICustomerTicketReplyRequestSend `multipart/form-data`: a `data` part contains the JSON fields, and repeated `ticket_images` parts contain files.ICustomerTicketReplyWaitWhy the customer cannot add a message to a support ticket right now.ICustomerTicketsRequestUse `filters` for selection and `paginate` for pages. Empty filters list all tickets belonging to the user’s account.ICustomerTicketsResponseCustomer tickets, pagination and optional first-page open/closed counts.ICustomerTicketSubscriptionRequestSend `multipart/form-data`: a `data` part contains the JSON fields, and repeated `ticket_images` parts contain files.TicketReplyWaitReasonReason of a support reply wait: `support_reply` or `delay`.
transport
ApiFormErrorValidation error message and code.AppLoadFailureInitialization failure with its category, status and field errors.AppLoadRequestBootstrap request options for detail level and cache bypass.AppLoadResponseAPI response envelope containing Application Load data or errors.AppLoadResultLoaded Application Load response with its HTTP status and load time.JsonValueA value that can be represented as JSON.