@tanqory/sdk
Enumerations
- CustomerStatus
- DiscountStatus
- DiscountType
- MemberRole
- PaymentStatus
- ProductStatus
- StoreStatus
- SubscriptionStatus
Classes
- AIAssistantService
- AIAssistService
- AnalyticsService
- AuthService
- BillingService
- BlogsService
- CheckoutService
- ContentService
- CursorPaginatedIterator
- CustomerAddressesService
- CustomerComputedTraitsService
- CustomerEventsService
- CustomerPrivacyService
- CustomersCoreService
- CustomerSegmentsService
- CustomersService
- CustomerStoreCreditService
- DiscountsService
- DomainsService
- EmailService
- GiftCardViewsService
- InterceptorManager
- Interceptors
- InventoryLocationsService
- InventoryService
- InvoiceViewsService
- LanguagesService
- LocationsService
- MarketingService
- MarketsService
- MediaService
- MetafieldsService
- MetaobjectsService
- NotificationsService
- OrdersService
- PagesService
- PaginatedIterator
- PaymentSettingsService
- PaymentsService
- PixelsService
- PoliciesService
- ProductCategoriesService
- ProductsService
- ProductSubscriptionsService
- ProductViewsService
- PurchaseOrdersService
- SearchService
- SellingPlansService
- SettingsService
- StoresService
- SubscriptionService
- SuppliersService
- TanqoryAPIError
- TanqoryAuthenticationError
- TanqoryClient
- TanqoryConfigurationError
- TanqoryConflictError
- TanqoryError
- TanqoryIdempotencyError
- TanqoryNetworkError
- TanqoryNotFoundError
- TanqoryPermissionError
- TanqoryRateLimitError
- TanqoryServerError
- TanqoryTimeoutError
- TanqoryValidationError
- TanqoryWebhookSignatureError
- TaxesService
- ThemesService
- TimelineService
- WebhooksService
Interfaces
- ActivateDutiesDto
- AddCommentRequest
- AddStaffRecipientInput
- AddTemplateInput
- AddTemplateResponse
- AiAssistantActionHistoryOptions
- AiAssistantListOptions
- AiAssistantMessagesOptions
- AIAssistConfig
- AiPageContext
AIPageContext- AllDomainsResponse
- ApplyDiscountRequest
- AssistChatRequest
- AssistChatResponse
- AssistContext
- AssistMessageRequest
- AssistStreamEvent
- AssistStreamEventData
- AssociateProductsResponse
- AssociateVariantsResponse
- AuthCodeResponse
- AutoConnectDomainResponse
- AutoPaginateOptions
- BatchOptions
- BatchProgress
- BulkAdjustResult
- BulkOperationResponse
- CacheAdapter
- CacheConfig
- Checkout
- CheckoutAddress
- CheckoutLineItem
- CheckoutResponse
- CheckoutTotals
- ClientOptions
- CloudflareConnectResponse
- CloudflareStatusResponse
- CompleteCheckoutRequest
- ConfirmationDetail
- ConfirmationResponse
- CreateCheckoutRequest
- CreateGiftCardViewInput
- CreateMediaBoardInput
- CreateMediaLibraryInput
- CreatePaymentSessionParams
- CreateProductViewInput
- CreateTaxOverrideDto
- CreateWebhookInput
- CssAssetListResponse
- CursorPaginatedResponse
- CustomDomainResponse
- CustomsInfoResponse
- CustomsProductItem
- DeviceInfo
- DnsDebugInfoResponse
- DnsHostRecord
- DnsHostsResponse
- DnsNameserversResponse
- DnsRecord
- DnsVerificationCheckResponse
- DomainAvailabilityResponse
- DomainConnectSupportResponse
- DomainConnectUrlResponse
- DomainPurchaseResponse
- DomainRegistrantInfo
- DomainSearchResponse
- DomainSearchResult
- DomainStatsResponse
- DomainTransferResponse
- DutiesMarket
- DutiesSettings
- EditCommentRequest
- EmailForwardingResponse
- EmailForwardRule
- EmailTemplate
- EuVatRate
- EuVatRatesResponse
- ExchangeRate
- FillCurrentFormResponse
- FormFieldSchema
- FormFieldToFill
- FormPayloadSchema
- GeoLocation
- GetRenderedSectionOptions
- GetToolsResponse
- GiftCardView
- GiftCardViewFilters
- GlobalSearchOptions
- GlobalSearchResponse
- GlobalTaxSettingsResponse
- HealthResponse
- HsCodeItem
- HsCodesSearchResponse
- HsSection
- HsSectionsResponse
- InterceptorHandler
- InterceptorRequestConfig
- InterceptorResponse
- ListMediaBoardsQuery
- ListMediaLibraryQuery
- ListOptions
- ListTemplatesResponse
- MarketItem
- MediaBoard
- MediaBoardItemWithMedia
- MediaBoardWithItems
- MediaBoardWithPreview
- MediaLibraryItem
- MediaStatsResponse
- MediaUsageInfo
- MediaUsageResponse
- MentionableStaffMember
- Money
- NavigateAndFillResponse
- NavigateResponse
- NetworkAdapter
- NetworkRequest
- NotificationCategory
- NotificationResponse
- NotificationSettings
- Order
- OrderResponse
- PageContext
- PaginatedBillingAttemptsResponse
- PaginatedResponse
- PaginatedSellingPlanGroupsResponse
- PaginatedSubscriptionContractsResponse
- PaginationMeta
- PaginationOptions
- ParsedTemplateResponse
- ParsedTemplateSection
- PaymentSession
- PendingAction
- PostalCodeResult
- ProductView
- ProductViewFilters
- PurchaseDomainInput
- QuickActionResponse
- RagArticle
- RagContext
- RenderedSectionResponse
- ReorderBoardItemsInput
- RequestOptions
- RetryConfig
- SDKEventMap
- SDKInfo
- SDKTelemetry
- SearchResultItem
- SearchStockPhotosQuery
- SellingPlanAllocation
- ShippingMethod
- ShippingRate
- ShippingRatesResponse
- ShopContext
- SSLCertificateResponse
- StaffNotification
- StaffNotificationRecipient
StockPhoto- StockPhotoItem
StockPhotoSearchResult- StockPhotosSearchResult
- StorageAdapter
- StoreCssAssetListResponse
- StoreThemeEditorDataResponse
- StreamChunk
- StreamOptions
- StreamResponse
- SubscriptionSummaryResponse
- SuccessMessageResponse
- SyncProductMediaUsagesInput
- TanqoryConfig
- TanqoryErrorOptions
- TanqorySubdomainResponse
- TaskContext
- TaxCalculateRequest
- TaxCalculateResponse
- TaxCategoriesResponse
- TaxCategory
- TaxCountriesResponse
- TaxCountry
- TaxCountryDetail
- TaxJurisdictionRef
- TaxOverride
- TaxRateRef
- TaxRatesResponse
- TaxRegionDetailItem
- TaxRegionListItem
- TaxRegionRef
- TaxServiceResponse
- TaxSubRegion
- TelemetryConfig
- TemplateListItem
- TextResponse
- ThemeFile
- ThemeFileNode
- ThemeFileTree
- TimelineAttachment
- TimelineEvent
- TimelineMention
- ToggleAutoRenewResponse
- ToggleFavoriteResponse
- ToggleWhoisPrivacyResponse
- ToolCall
- ToolInfo
- UnifiedUploadInput
- UpdateCheckoutRequest
- UpdateCustomsProductDto
- UpdateDutiesMarketDto
- UpdateDutiesSettingsDto
- UpdateGiftCardViewInput
- UpdateGlobalTaxSettingsDto
- UpdateMediaBoardInput
- UpdateMediaLibraryInput
- UpdateNotificationSettingsInput
- UpdateProductViewInput
- UpdateSubRegionRateDto
- UpdateTaxRegionDto
- UpdateWebhookInput
UploadImageResponse- UploadOnlyResult
- UploadOptions
- UploadProgress
- UsSalesTaxRate
- UsSalesTaxResponse
- WebhookResponse
- WhoisInfo
Type Aliases
- AccountDeletionResponse
- ActivityLogQuery
- ActivityLogResponse
- ActivityLogsListResponse
- AddCustomerAddressRequest
- AddCustomerAddressResponse
- AddCustomerNoteRequest
- AddCustomerNoteResponse
- AddCustomItemToOrderEditInput
- AddDiscountTimelineCommentInput
- AddFulfillmentEventInput
- AddOrderEditDiscountInput
- AddSecondaryEmailResponse
- AddVariantToOrderEditInput
- AdjustInventoryInput
- AdjustInventoryRequest
- AdjustStoreCreditInput
AiResponse- AISegmentGenerateRequest
- AISegmentGenerateResponse
- AISegmentSuggestImprovementsResponse
- APIResponse
- ApiVersion
- ApplyStoreCreditInput
- ApproveReturnInput
- ArchiveSegmentResponse
- AssistPageType
- AssistResourceType
- AssistResponse
- AssistResponseType
- AssistStreamEventType
- AuthResponse
- AuthTokens
- AuthUser
- BackupCodeVerifyResponse
- BeginOrderEditInput
- BillingCycle
- BulkActionResponse
- BulkAutoRenewInput
- BulkDeleteDiscountsInput
- BulkDiscountRequest
- BulkDnsUpdateInput
- BulkEmailRequest
- BulkRenewDomainsInput
- BulkRevokeSessionsResponse
- BulkSmsRequest
- BulkStatusChangeInput
- BulkTagRequest
- BulkUpdateDiscountsInput
- CalculatedOrderSummary
- CalculateOrderEditPreviewInput
- CalculateOrderEditPreviewResponse
- CalculateOrderRequest
- CalculateOrderResponse
- CalculateRefundRequest
- CalculateRefundResponse
- CancelFulfillmentInput
- CancelReturnInput
- CapturePaymentInput
- CapturePaymentResponse
- CheckEmailResponse
- CheckoutSessionResponse
- CheckoutStatus
- CommitOrderEditInput
- CommitOrderEditResponse
- CommittedOrdersResponse
- ConfirmationVariant
- ConnectSocialAccountResponse
- ContentFile
- ContentType
- CreateAuthorizationInput
- CreateCheckoutSessionInput
- CreateComputedTraitRequest
- CreateComputedTraitResponse
- CreateCustomerEventRequest
- CreateCustomerEventResponse
- CreateCustomerInput
- CreateCustomerRequest
- CreateCustomerResponse
- CreateCustomerSegmentRequest
- CreateCustomerSegmentResponse
- CreateCustomerTimelineCommentRequest
- CreateDiscountInput
- CreateFulfillmentInput
- CreateFulfillmentResponse
- CreateIossRegistrationDto
- CreateMenuResponse
- CreateOrderInput
- CreateOrderRequest
- CreateOrderResponse
- CreateOssRegistrationDto
- CreatePageInput
- CreatePaymentInput
- CreatePayPalSubscriptionInput
- CreateProductInput
- CreateRefundResponse
- CreateRefundTransactionInput
- CreateSaleInput
- CreateStoreInput
- CurrenciesByRegionResponse
- CurrenciesPaginationMeta
- CurrencyListItem
- CurrencyRegion
- CursorPageFetcher
- Customer
- CustomerAddress
- CustomerAnalyticsParams
- CustomerAnalyticsResponse
- CustomerPaymentMethodResponse
- CustomerTimeline
- CustomerTimelineCommentResponse
- DataExportResponse
- DeclineReturnInput
- DeleteComputedTraitResponse
- DeleteCustomerAddressResponse
- DeleteCustomerResponse
- DeleteCustomerSegmentResponse
- DeleteCustomerTimelineCommentResponse
- DeletedResponse
- DeleteResponse
- DisableMfaResponse
- Discount
- DiscountAnalytics
- DiscountCheckoutErrorCode
- DiscountCheckoutErrorMeta
- DiscountCheckoutValidationResult
- DiscountDetailResponse
- DiscountPerformance
- DiscountQueryParams
- DiscountTimeline
- DiscountTimelineType
- DiscountTypeType
- DiscountValidationResult
DomainContactInfo- DomainManagedBy
- DomainTarget
- DomainType
- DraftOrder
- DraftOrderTimeline
- DuplicateOrderRequest
- DuplicateSegmentResponse
- EditDiscountTimelineCommentInput
- Environment
- ErrorCode
- EvaluateSegmentRequest
- EvaluateSegmentResponse
- ExportActivityLogQuery
- ExportDiscountsInput
- ExportDiscountsResult
- ExportSegmentResponse
- Fulfillment
- FulfillmentEvent
- FulfillmentOrder
- FulfillOrderResponse
- GenerateAiEmailTemplateInput
- GenerateAiEmailTemplateResponse
- GenerateImageResponse
- GetCategoryAncestorsResponse
- GetCategoryAttributesResponse
- GetCustomerTimelineResponse
- GetReturnableItemsResponse
- GetSegmentAnalyticsResponse
- GetSegmentCustomersResponse
- GetSegmentMembershipChangesResponse
- GetSegmentTopMembersResponse
- GetSegmentTrendResponse
- HasPasswordResponse
- HighRiskOrdersResponse
- HoldFulfillmentOrderInput
- HttpMethod
- InitiateMfaRecoveryResponse
- InventoryItem
- Invoice
- InvoicePreviewResponse
- IossRegistration
- IssueStoreCreditInput
- ListComputedTraitsParams
- ListComputedTraitsResponse
- ListCurrenciesParams
- ListCurrenciesResponse
- ListCustomerAddressesResponse
- ListCustomerEventsParams
- ListCustomerEventsResponse
- ListCustomerNotesResponse
- ListCustomerOrdersParams
- ListCustomerOrdersResponse
- ListCustomerSegmentsParams
- ListCustomerSegmentsResponse
- ListCustomersParams
- ListCustomersResponse
- ListFulfillmentOrdersParams
- ListFulfillmentOrdersResponse
- ListFulfillmentsParams
- ListFulfillmentsResponse
- ListMenusParams
- ListMenusResponse
- ListOrderEditsResponse
- ListOrdersResponse
- ListRefundsParams
- ListRefundsResponse
- ListReturnsQuery
- ListReturnsResponse
- ListSegmentTemplatesResponse
- ListStoreCreditTransactionsParams
- ListStoreCreditTransactionsResponse
- ListStoreTransactionsParams
- ListStoreTransactionsResponse
- ListTransactionsParams
- ListTransactionsResponse
- ListTransfersResponse
- LoginInput
- MarkAllReadResponse
- MergeFulfillmentOrdersInput
- MessageResponse
- MfaChallenge
- MfaMethod
- MfaStatusResponse
- MfaVerifySetupResponse
- ModifySegmentCustomersRequest
- ModifySegmentCustomersResponse
- MoveFulfillmentOrderInput
- OrderEditStatus
- OrderEditWithDetails
- OrderFulfillmentSummary
- OrderItem
- OrderPaymentSummary
- OrderRefundSummary
- OrderReturnSummary
- OrderStatus
- OrderTimeline
- OrderTransaction
- OssRegistration
- OssSalesResult
- PageFetcher
- PaginatedSessionsResponse
- PaymentMethod
- PhoneVerificationResponse
- PreviewSegmentRequest
- PreviewSegmentResponse
- Product
- ProductVariant
- ProfileResponse
- QueryNotifications
- RefreshComputedTraitResponse
- RefreshSegmentResponse
- RefreshTokenResponse
- Refund
- RefundToStoreCreditInput
- RegenerateBackupCodesResponse
- RegisterInput
- RegisterResponse
- RemoveOrderEditLineItemInput
- RemoveReturnLineItemsInput
- ReopenReturnInput
- RequestExchangeInput
- RequestInterceptorFulfilled
- RequestInterceptorRejected
- RequestReturnInput
- RequestSmsDisableResponse
- RescheduleFulfillmentOrderInput
- ResetPasswordInput
- ResponseInterceptorFulfilled
- ResponseInterceptorRejected
- RetrieveComputedTraitResponse
- RetrieveCustomerResponse
- RetrieveCustomerSegmentResponse
- ReturnProcessInput
- ReturnProcessResponse
- ReturnWithDetails
- RevokeSessionResponse
- SearchResourceType
- SegmentAnalyticsParams
- SegmentMembershipChangesParams
- SendInvoiceInput
- SessionData
- SessionQuery
- SessionResponse
- SmsSetupResponse
- SocialAccountResponse
- SocialAccountsListResponse
- SplitFulfillmentOrderInput
- SplitFulfillmentOrderResponse
- StockCategory
- StockMediaType
- StockOrientation
- StockPhotoProvider
- Store
- StoreCreditSummary
- StoreCreditTransaction
- StoreMember
- StoreSubscriptionResponse
- Subscription
- SubscriptionBillingAttempt
- SubscriptionBillingAttemptResponse
- SubscriptionContract
- SubscriptionContractResponse
- SubscriptionPlanResponse
- SubscriptionResponse
- SubscriptionStatusResponse
- SuccessResponse
- SuggestedFinancialOutcome
- SuggestedRefund
- SymbolPosition
- TaxonomyAttributeWithValues
- TimelineEntityType
- TimeRange
- TotpSetupResponse
- TransferInInput
- TransferOutInput
- TransferStoreCreditInput
- TrialStatusResponse
- UpdateComputedTraitRequest
- UpdateComputedTraitResponse
- UpdateCustomerAddressRequest
- UpdateCustomerAddressResponse
- UpdateCustomerInput
- UpdateCustomerRequest
- UpdateCustomerResponse
- UpdateCustomerSegmentRequest
- UpdateCustomerSegmentResponse
- UpdateCustomerTimelineCommentRequest
- UpdateDiscountInput
- UpdateEmailTemplateInput
- UpdateIossRegistrationDto
- UpdateOrderEditLineItemQuantityInput
- UpdateOrderInput
- UpdateOrderRequest
- UpdateOssRegistrationDto
- UpdatePreferencesInput
- UpdateProductInput
- UpdateProfileInput
- UpdateSettingsInput
- UpdateStaffNotificationInput
- UpdateStaffNotificationScheduleInput
- UpdateStoreInput
- UpdateTrackingStatusInput
- UpdateTransactionStatusInput
- User
- ValidateDiscountCodeInput
- ValidateSegmentQueryResponse
- VerifyEmailResponse
- VerifyMfaRecoveryResponse
- VoidPaymentInput
- VoidPaymentResponse
- WebhookEvent
- WSEvent
Variables
- API_VERSIONS
- CACHE_KEYS
- CONTENT_TYPES
- DEFAULT_CONFIG
- ENVIRONMENTS
- ERROR_CODES
- HEADERS
- HTTP_METHODS
- PAGINATION
- RETRY
- SDK
- STORAGE_KEYS
- STREAMING_TIMEOUT_MS
- WEBHOOK_EVENTS
- WS_EVENTS
Functions
- buildFilterQuery
- buildPaginationQuery
- cacheIdempotentResponse
- constructWebhookEvent
- createClient
- createCursorPaginatedIterator
- createHeaderInterceptor
- createLoggingInterceptor
- createPaginatedIterator
- createRetryInterceptor
- createTelemetryInterceptor
- createTimingInterceptor
- executeErrorInterceptors
- executeRequestInterceptors
- executeResponseInterceptors
- extractPaginationMeta
- generateIdempotencyKey
- getExchangeRate
- getGeoLocation
- getIdempotentResponse
- isRetryableError
- isTanqoryError
- lookupDns
- lookupJapanPostalCode
- lookupPostalCode
- lookupRdap
- lookupWhois
- processBatches
- verifyWebhookSignature
References
ApiError
Renames and re-exports TanqoryAPIError
CursorPageFetcher
Re-exports CursorPageFetcher
CustomsProduct
Renames and re-exports CustomsProductItem
default
Renames and re-exports createClient
LoginResponse
Renames and re-exports AuthResponse
MfaStatus
Renames and re-exports MfaStatusResponse
PageFetcher
Re-exports PageFetcher
PaginatedSessions
Renames and re-exports PaginatedSessionsResponse
SocialAccount
Renames and re-exports SocialAccountResponse