docs
OverviewCommerce APIStorefront APIUser GuideExplorer
Types > SynonymSettingsCreate
Search docs
/
Addresses
Analytics
Authentication
Content
Customers
Info
Integrations
Inventory
Locales
Orders
Payments
Products
Promotions
Returns
Reviews
Search
Shipping
Shops
Taxes
Templates
Types
Achievements
Activity
ActivityPage
ActivityType
Address
AddressCreate
AddressShort
AddressShortCreate
AddressVerification
AddressVerificationStatus
AnalyticsCustomReports
AnalyticsCustomReportsCreate
AnalyticsDashboard
AnalyticsDashboardCreate
AnalyticsQuery
AnalyticsReport
AnalyticsReportParameters
AnalyticsReportRow
AnswerCreate
AnswerModify
ApplePayDomain
ApplePayDomainCreate
ApplyGiftCard
ApprovalStatus
ArbitraryObjectType
AuditLog
AuditLogPage
AuspostOptions
AuspostOptionsCreate
AutoBoolean
Boolean
Brand
BrandCreate
BrandExpandableItems
BrandModify
BrandPage
BrandSearchResult
BrandSortOrder
Branding
BrandingCreate
BrandingField
BrandingFieldCreate
BrandingFieldType
BrandsPageSortBy
BundleLineItem
BundleLineItemCreate
BuyLink
BuyLinkCreate
BuyLinkLineItem
BuyLinkLineItemCreate
BuyLinkModify
CalculatedRefund
CalculatedRefundLineItem
CalculatedRefundShippingLine
CanadapostOptions
CanadapostOptionsCreate
Category
CategoryAncestor
CategoryCount
CategoryCreate
CategoryExpandableItems
CategoryModify
CategorySearchResult
CategorySortOrder
CertStatus
ContentBlock
ContentBlockCreate
ContentBlockExpandableItems
ContentBlockModify
ContentBlockPage
ContentBlockSearchResult
ContentBlocksPageSortBy
ContentModel
ContentModelCreate
ContentModelModify
Coupon
CouponBulk
CouponBulkFormat
CouponCreate
CouponPage
CouponsPageSortBy
Currency
CurrencyCreate
CurrencyFormat
CurrencyFormatCreate
CurrencyHistory
CurrencyHistoryEntry
CurrencyInfo
CurrencyModify
CurrencyPrice
CustomField
CustomFieldCreate
CustomFieldObjects
CustomItemIndex
Customer
CustomerBalance
CustomerBalanceCreate
CustomerBalanceHistory
CustomerBalanceHistoryPage
CustomerBalancePerCurrency
CustomerBalanceSource
CustomerCategory
CustomerCreate
CustomerExpandableItems
CustomerFavorite
CustomerFavoriteCreate
CustomerFavoriteModify
CustomerFavoritePage
CustomerGroup
CustomerGroupCreate
CustomerGroupModify
CustomerGroupPrice
CustomerInventory
CustomerInventoryCreate
CustomerInventoryExpandableItems
CustomerInventoryItemTypeParam
CustomerInventoryModify
CustomerInventoryPage
CustomerInventoryPageSortBy
CustomerInventorySearchResult
CustomerInventoryType
CustomerInventoryTypeFilter
CustomerInventoryTypeParam
CustomerModify
CustomerOAuthProvider
CustomerOAuthProviderCreate
CustomerOAuthProviderKind
CustomerPage
CustomerPasswordReset
CustomerPaymentSource
CustomerPaymentSourceCreate
CustomerPaymentSourceModify
CustomerReviewReminder
CustomerSearchResult
CustomersPageSortBy
DataFeed
DataFeedCreate
DataFeedField
DataFeedFieldCreate
DataFeedModify
DataFeedPreview
DataFeedSchedule
DataFeedStatus
Device
DeviceModify
Domain
DomainCreate
DomainEmailAuth
DomainEmailAuthDnsEntry
DomainFieldStatus
DomainSendInstructions
EmailRecipient
ExportOptions
FavoriteSortBy
FavoriteType
FedexOptions
FedexOptionsCreate
File
FileCreate
FileExpandableItems
FileIDAndURL
FileModify
FilePage
FileQuery
FileSearchResult
FileStats
FileStorage
FileURL
FilesPageSortBy
Float
ForeignShardedTask
FulfillmentLineItem
FulfillmentService
FulfillmentTrackingEvent
FulfillmentTrackingEventCreate
FulfillmentType
Gateway
GatewayCreate
GatewayCurrency
GatewayCurrencyCreate
GatewayManual
GatewayManualCreate
GatewayModify
GatewayPaypal
GatewayPaypalCards
GatewayPaypalCardsCreate
GatewayPaypalCreate
GatewayPaypalFunding
GatewayPaypalFundingCreate
GatewayStripe
GatewayStripeCards
GatewayStripeCardsCreate
GatewayStripeCreate
GatewayStripePaymentMethods
GatewayStripePaymentMethodsCreate
GatewayTest
GatewayTestCreate
GatewayType
GatewayVisibility
GenericExport
GenericImport
IPAndUAInfo
ImageType
ImportOptions
InfoCSVColumn
InfoCSVFormat
InfoCarrierPackaging
InfoCountry
InfoCountryDedupField
InfoCountryLabels
InfoCurrency
InfoDataFeedField
InfoDataFeedPreset
InfoDataFeedPresetField
InfoDataFeeds
InfoHSCode
InfoHSCodeChapter
InfoHSCodeHeading
InfoHSCodeSection
InfoHSCodeSubheading
InfoLanguage
InfoMccCode
InfoPermission
InfoProvince
InfoRole
InfoShippingProvider
InfoTimezone
InfoWebhook
Int
InventoryLocation
InventoryLocationCreate
InventoryLocationDateRange
InventoryLocationDateRangeCreate
InventoryLocationDayHour
InventoryLocationDayHourCreate
InventoryLocationHour
InventoryLocationHourCreate
InventoryLocationModify
InventoryLocationRelevantHours
InventoryLocationRelocate
InventoryLocationSpecialHours
InventoryLocationSpecialHoursCreate
InventoryLogType
InventoryManagement
InventoryPolicy
InventoryRule
InventoryRuleCreate
InventoryRuleLookupResult
InventoryRuleModify
InventoryRulesGraph
InventoryRulesGraphCreate
InventoryStockStatus
InventoryStockStatusAggregated
InventoryStrategy
InventorySummary
Invitation
InvitationCreate
Invoice
InvoiceLine
InvoicePage
InvoiceStatus
InvoiceType
JurisdictionSlot
Key
KeyCreate
KeyModify
KeyValue
KeyValueCreate
LengthUnit
LineItemField
LineItemFieldCreate
MediaFile
MediaFileCreate
Menu
MenuCreate
MenuItem
MenuItemCreate
MenuItemType
MenuModify
MenuPage
MenusPageSortBy
Message
MessageType
MinCurrencyPrice
MinCustomerGroupPrice
Note
NoteCreate
NoteModify
OAuth2Provider
OICustomItem
OIFulfillmentLineItem
OIFulfillmentTrackingEvent
OIIPAndUAInfo
OIOrder
OIOrderBundleLineItemDetail
OIOrderDetailsLineItemInventory
OIOrderFulfillment
OIOrderHistory
OIOrderHistoryAuthorizeTransaction
OIOrderHistoryCancel
OIOrderHistoryCaptureTransaction
OIOrderHistoryChange
OIOrderHistoryFulfillmentCanceled
OIOrderHistoryFulfillmentCompleted
OIOrderHistoryFulfillmentCreated
OIOrderHistoryFulfillmentModified
OIOrderHistoryManualPayment
OIOrderHistoryManualRefund
OIOrderHistoryRefundLineItem
OIOrderHistoryRefundTransaction
OIOrderHistoryRestock
OIOrderHistoryRestockLineItem
OIOrderLineItem
OIOrderLineItemDetail
OIPaymentDetail
OIPaymentDetailCard
OIPaymentDetailClient
OIShippingDetail
OITaxDetail
Option
OptionCreate
OptionModify
OptionSet
OptionSetCreate
OptionSetModify
OptionValue
OptionValueCreate
OptionalInt
OptionalIntCreate
Order
OrderBundleLineItemDetail
OrderCalcLog
OrderCancel
OrderCancelReason
OrderCreate
OrderCustomItem
OrderCustomItemCreate
OrderDetailsLineItemInventory
OrderDisplay
OrderExpandableItems
OrderFinancialStatus
OrderFulfillment
OrderFulfillmentCreate
OrderFulfillmentLineItemCreate
OrderFulfillmentModify
OrderFulfillmentStatus
OrderHistory
OrderHistoryAction
OrderHistoryAuthorizeTransaction
OrderHistoryCancel
OrderHistoryCaptureTransaction
OrderHistoryChange
OrderHistoryFulfillmentCanceled
OrderHistoryFulfillmentCompleted
OrderHistoryFulfillmentCreated
OrderHistoryFulfillmentModified
OrderHistoryManualPayment
OrderHistoryManualRefund
OrderHistoryRefundLineItem
OrderHistoryRefundTransaction
OrderHistoryRestock
OrderHistoryRestockLineItem
OrderLineItem
OrderLineItemCreate
OrderLineItemDetail
OrderLineItemFulfillmentStatus
OrderModify
OrderOverride
OrderPage
OrderPayment
OrderPaymentCreditCard
OrderPaymentManual
OrderPaymentPaypal
OrderRefund
OrderRefundLineItem
OrderRefundReason
OrderRefundShipping
OrderRestock
OrderRestockLineItem
OrderRisk
OrderRiskBillingAddress
OrderRiskBillingAddressCreate
OrderRiskCreate
OrderRiskShipping
OrderRiskShippingAddress
OrderRiskShippingAddressCreate
OrderRiskShippingCreate
OrderRuleEvalDetail
OrderSearchResult
OrderSourceName
OrderState
OrderType
OrdersPageSortBy
PDFSignature
Packaging
PackagingCreate
PackagingModify
PackedBox
PackedItem
PaymentDetail
PaymentDetailBancontact
PaymentDetailCard
PaymentDetailCardCompany
PaymentDetailCardFunding
PaymentDetailClient
PaymentDetailEps
PaymentDetailGiropay
PaymentDetailIdeal
PaymentDetailMasterpass
PaymentDetailMultibanco
PaymentDetailP24
PaymentDetailSofort
PaymentDetailType
PaymentDetailVisaCheckout
PaymentMethod
PaymentMethodCreate
PaymentMethodCreditCard
PaymentMethodModify
Plan
PlanAnalyticsFlags
PlanCreate
PlanPreview
Product
ProductAnalytics
ProductBanMode
ProductCreate
ProductExpandableItems
ProductField
ProductFieldCreate
ProductFieldSet
ProductFieldSetCreate
ProductFieldSetModify
ProductFieldType
ProductModify
ProductPage
ProductQuestion
ProductQuestionAnswer
ProductQuestionAnswerPage
ProductQuestionCreate
ProductQuestionExpandableItems
ProductQuestionModify
ProductQuestionPage
ProductQuestionSearchResult
ProductQuestionsAnswersPageSortBy
ProductQuestionsPageSortBy
ProductReturnMode
ProductReview
ProductReviewAnswer
ProductReviewAnswerPage
ProductReviewAnswerSummary
ProductReviewAverageScore
ProductReviewCreate
ProductReviewExpandableItems
ProductReviewModify
ProductReviewPage
ProductReviewScore
ProductReviewScoreCreate
ProductReviewSearchResult
ProductReviewSurveyAnswer
ProductReviewSurveyAnswerCreate
ProductReviewsAnswersPageSortBy
ProductReviewsPageSortBy
ProductSearchOptionAgg
ProductSearchOptionValueAgg
ProductSearchResult
ProductVariant
ProductVariantCreate
ProductVariantModify
ProductVariantPage
ProductVariantPriceHistory
ProductVariantSearchResult
ProductVariantsPageSortBy
ProductsPageSortBy
ProfileImage
Promotion
PromotionCondition
PromotionConditionCreate
PromotionConditionType
PromotionCreate
PromotionExpandableItems
PromotionModify
PromotionPage
PromotionRule
PromotionRuleCreate
PromotionSearchResult
PromotionType
PromotionsPageSortBy
PromotionsPageStatus
PublishedStatus
PurchaseOrder
PurchaseOrderCategory
PurchaseOrderCreate
PurchaseOrderExpandableItems
PurchaseOrderLineItem
PurchaseOrderLineItemCreate
PurchaseOrderLineItemPartial
PurchaseOrderLog
PurchaseOrderLogItem
PurchaseOrderLogLineItem
PurchaseOrderLogType
PurchaseOrderModify
PurchaseOrderPage
PurchaseOrderReceive
PurchaseOrderReject
PurchaseOrderSearchResult
PurchaseOrderStatus
PurchaseOrdersPageSortBy
Query
QuickbooksAccount
QuickbooksLog
QuickbooksSettings
QuickbooksSettingsCreate
QuickbooksTaxMap
QuickbooksTaxMapCreate
QuickbooksTaxRate
QuickbooksTaxRateComponent
RecoveryOTP
ReindexingStatus
Return
ReturnApproval
ReturnApprove
ReturnCategory
ReturnCheck
ReturnCreate
ReturnHistory
ReturnHistoryAction
ReturnInspection
ReturnInspectionCreate
ReturnInspectionModify
ReturnLineItem
ReturnLineItemCreate
ReturnLineItemInspection
ReturnPage
ReturnPolicy
ReturnPolicyAddressType
ReturnPolicyCondition
ReturnPolicyConditionCreate
ReturnPolicyCreate
ReturnPolicyModify
ReturnPolicyRefundOption
ReturnPolicyReturnFee
ReturnPolicyShippingOption
ReturnPolicyShippingOptionCreate
ReturnReason
ReturnReasonCreate
ReturnReasonModify
ReturnReasonType
ReturnReceive
ReturnRefund
ReturnState
ReturnTrackingEvent
ReturnsPageSortBy
ReverseLogistics
ReviewDimension
ReviewDimensionCreate
ReviewDimensionModify
ReviewDimensionSet
ReviewDimensionSetCreate
ReviewDimensionSetModify
ReviewSettings
ReviewSettingsCreate
RiskLevel
Role
RoleCreate
RoleModify
RoundTaxAt
RuleOperator
SalesChannel
SalesChannelCreate
SalesChannelModify
ScheduledFulfillment
ScheduledFulfillmentCreate
ScheduledFulfillmentLineItem
ScheduledFulfillmentLineItemCreate
ScheduledFulfillmentModify
ScheduledFulfillmentReserve
ScheduledFulfillmentReserveLineItemCreate
SearchBrandsSortBy
SearchCategoriesSortBy
SearchContentBlocksSortBy
SearchCustomerInventorySortBy
SearchCustomersSortBy
SearchFilesSortBy
SearchOp
SearchOption
SearchOrdersSortBy
SearchProductsSortBy
SearchPromotionsSortBy
SearchPurchaseOrdersSortBy
SearchQuestionsSortBy
SearchReviewsSortBy
SearchSubscriptionsSortBy
SearchSuppliersSortBy
SearchTransfersSortBy
SearchVariantsSortBy
SentStatus
ShardedTask
ShardedTaskCSVImportInfo
ShardedTaskError
ShardedTaskExpandableItems
ShardedTaskProgress
ShardedTaskSpan
ShippingDetail
ShippingProvider
ShippingProviderCreate
ShippingProviderField
ShippingProviderFieldOption
ShippingProviderFieldType
ShippingProviderModify
ShippingProviderService
ShippingProviderTestAddress
ShippingProviderTestPackage
ShippingProviderTestRate
ShippingProviderTestResult
ShippingProviderType
ShippingProviderWhitelist
ShippingProviderWhitelistCreate
ShippingRate
ShippingRateGroup
ShippingRateGroupItem
ShippingRateGroupPolicy
ShippingRule
ShippingRuleCreate
ShippingRuleLookupProvider
ShippingRuleLookupResult
ShippingRuleModify
ShippingRulesGraph
ShippingRulesGraphCreate
ShippingTaxMethod
Shop
ShopCreate
ShopDeleteReason
ShopDeleteReasonParam
ShopIndustry
ShopModify
ShopPreviousService
ShopRevenue
ShopSettings
ShopSettingsCreate
ShopSettingsFeatures
ShopSettingsNotifications
ShopSettingsNotificationsCreate
ShopSettingsSubscription
ShopShort
ShopShortPage
SmsMessageSummary
StorefrontCustomerVote
String
Subscription
SubscriptionEdit
SubscriptionError
SubscriptionExpandableItems
SubscriptionPage
SubscriptionParam
SubscriptionPlan
SubscriptionPlanCreate
SubscriptionPlanIndex
SubscriptionPlanInterval
SubscriptionPlanPriceType
SubscriptionSearchResult
SubscriptionState
SubscriptionsPageSortBy
Supplier
SupplierCreate
SupplierExpandableItems
SupplierModify
SupplierPage
SupplierSearchResult
SuppliersPageSortBy
SurveyQuestion
SurveyQuestionCreate
SurveyQuestionKind
SurveyQuestionModify
SynonymEntry
SynonymEntryCreate
SynonymEntryKind
SynonymSettings
SynonymSettingsCreate
Task
TaskCreate
TaskMessage
TaskMessageCreate
TaskMessageType
TaskModify
TaskType
TaskTypeParam
TaxBasedOn
TaxDetail
TaxRule
TaxRuleCreate
TaxRuleLookupRate
TaxRuleLookupResult
TaxRuleModify
TaxRulesGraph
TaxRulesGraphCreate
TaxSystem
TaxSystemCreate
TaxTypeApplicable
TestEmail
TestEmailPage
TestSms
TestSmsPage
TieredPricing
TieredPricingCreate
TieredPricingMode
TieredPricingModel
TieredPricingTier
TieredPricingTierCreate
Token
TokenAndUserID
TrackingEventStatus
Transfer
TransferCategory
TransferCreate
TransferExpandableItems
TransferLineItem
TransferLineItemCreate
TransferLog
TransferLogItem
TransferLogLineItem
TransferLogType
TransferModify
TransferPage
TransferReceive
TransferReject
TransferSearchResult
TransferStatus
TransfersPageSortBy
TwoFactor
UIPreference
UIPreferenceCreate
UPSOptions
UPSOptionsCreate
USPSOptions
USPSOptionsCreate
UnifiedSearchResult
UnifiedSearchResultScore
UnpackedItem
UsageStat
User
UserClass
UserCreate
UserEmail
UserEmailCreate
UserFile
UserFileCreate
UserLogin
UserModify
UserPasswordReset
UserPasswordResetComplete
UserPasswordResetVerify
VariantCurrencyPrice
VariantCustomerGroupPrice
VariantInventory
VariantInventoryCreate
VariantInventoryLocation
VariantInventoryLog
VariantInventoryLogPage
VariantInventoryLogPageSortBy
VariantOption
VariantOptionCreate
VariantSupplier
VariantSupplierCreate
VariantType
VariantTypeFilter
WebauthnAdd
WebauthnKey
WebauthnResponse
Webhook
WebhookAttemptOutcome
WebhookCRCStatus
WebhookCreate
WebhookEvent
WebhookEventPage
WebhookEventStatus
WebhookEventStatusPage
WebhookModify
WeightUnit
Workflow
WorkflowCreate
WorkflowExec
WorkflowExecPage
WorkflowExecute
WorkflowExecuteResult
WorkflowModify
XeroAccount
XeroInvoiceStatus
XeroLog
XeroPaymentMap
XeroPaymentMapCreate
XeroSettings
XeroSettingsCreate
XeroTaxMap
XeroTaxMapCreate
XeroTaxRate
XeroTaxRateComponent
ZipCodeType
Zone
ZoneCreate
__Directive
__DirectiveLocation
__EnumValue
__Field
__InputValue
__Schema
__Type
__TypeKind
Users
No auth
Commerce APITypesSynonymSettingsCreate
SynonymSettingsCreate