Search docs
Sign InDescription
Modify shop settings.
Permission bit: "shop_settings.modify"
Topic: Shops
Arguments
data: ShopSettingsCreate!
Main argument for mutations.
Unique shop identifier. See also: Unique Identifiers
Example: "sh_EQzGqWoY"
Data Argument Fields
Whether to verify shipping addresses on paid orders
Example: false
address_verification_auto: Boolean
Whether to automatically apply shipping address verification result to shipping address
Example: false
Automatically close completed orders (fulfilled/paid)
Example: false
Automatically fulfill digital items of captured orders
Example: false
auto_reserve_subscription: Boolean
Whether subscriptions should automatically reserve scheduled fulfillments or not
Example: false
billing_address: AddressCreate
Billing address of the shop
Whether to keep prices consistent across borders (only relevant for tax inclusive prices)
Example: true
Additional text to add to a shop billing invoice
Valid when: custom_invoice_text's length doesn't exceed 4096 characters
customer_can_pause_subscription: Boolean
Whether customer is allowed to pause subscriptions
Example: true
customer_can_skip_subscription: Boolean
Whether customer is allowed to skip subscription ticks
Example: true
customer_oauth_providers: [CustomerOAuthProviderCreate!]
OAuth2 providers for customer auth
customer_service_email: String
This address is mentioned in emails sent to customers
Example: "iwanbk-shop@apple.com"
Valid when: customer_service_email's length doesn't exceed 250 characters
default_payment_method_id: String
Unique payment method identifier. See also: Unique Identifiers
Example: "pm_EQzGqWoY"
Valid when: default_payment_method_id matches regexp pattern: ^pm_
Unique tax rule identifier. See also: Unique Identifiers
Example: "tr_EQzGqWoY"
Valid when: default_tax_rule_id matches regexp pattern: ^tr_
Whether gift cards are enabled or not (not available on Micro)
Example: false
gift_card_expiration_seconds: Int
If not null, created gift cards will expire after given amount of seconds
Example: 86400
Valid when: gift_card_expiration_seconds is a non-negative integer
Whether shop was created indirectly for a client
Example: false
industry: ShopIndustry
Industry this shop belongs to
Default invoice due date days to add when sending invoice
Example: 7
Valid when: invoice_due_date_days is a non-negative integer
Languages shop works with (you can override many text fields with language-specific variants)
Name of the shop
Example: "Apple Computers"
Valid when: name is not empty
Email for shop notifications
Example: "john@smith.com"
Valid when: notification_email's length doesn't exceed 250 characters
notifications: ShopSettingsNotificationsCreate
on_hold_order_window_minutes: Int
When order is on hold, customer can cancel the order and shop owner cannot fulfill the order
Valid when: on_hold_order_window_minutes is a non-negative integer
order_risk_cancel_threshold: Float
Automatically cancel orders with risk score higher than this number (if non-null)
Example: 0.70
Valid when: order_risk_cancel_threshold is a non-negative float
order_risk_warning_threshold: Float
Notify shop owner about orders with risk score higher than this number (if non-null)
Example: 0.15
Valid when: order_risk_warning_threshold is a non-negative float
Password used for shop password protection (cannot be disabled while in trial period)
Example: "unicorn"
Valid when: password's length doesn't exceed 250 characters
Message displayed on a "password" page when password protection is on
Translatable
Example: "Will be opening soon..."
Valid when: password_message's length doesn't exceed 4096 characters
previous_service: ShopPreviousService
Shop's previous service prior to registeration
product_review_enabled: Boolean
Whether product reviews are enabled or not (not available on Micro)
Example: false
revenue: ShopRevenue
Revenue of the shop prior to registeration
round_tax_at: RoundTaxAt
At what level the tax should be rounded
send_abandoned_email_after_seconds: Int
When customer abandons an order, notify him after that period of time
Example: 54346
Valid when: send_abandoned_email_after_seconds is in range: 1800 ≤ send_abandoned_email_after_seconds ≤ 86400
send_abandoned_email_min_price: Int
Minimum order price to send abandoned order email for
Example: 0
Valid when: send_abandoned_email_min_price is a non-negative integer
This address will be used as From for all emails sent to customers and suppliers
Example: "no-reply@apple.com"
Valid when: sender_email's length doesn't exceed 250 characters
Tax class used for tax selection when 'shipping_tax_method' is 'custom'
Valid when: shipping_tax_class's length doesn't exceed 250 characters
shipping_tax_method: ShippingTaxMethod
Method that is used to calculate shipping tax
shop_address: AddressCreate
Address of the shop
Starting number for orders
Example: 1000
Valid when: start_number is a non-negative integer
subscription_retries_schedule: [Int!]
Custom retry schedule in days if subscription fails, use default if empty
subscription_retries_schedule_daily: [Int!]
Custom retry schedule in hours if daily subscription fails, use default if empty
subtotal_includes_tax: Boolean
Whether subtotal includes tax or not (only affects display, not the API's "subtotal")
Example: false
tax_based_on: TaxBasedOn
Tax calculation should be based on
True if prices are tax inclusive, false if exclusive
Example: false
How the tax line is displayed. E.g. "Tax" or "Sale Tax"
Example: "Sale Tax"
Valid when: tax_label's length doesn't exceed 250 characters
Name of the time zone the shop is in
Example: "(GMT-05:00) Eastern Time"
Valid when: timezone's length doesn't exceed 50 characters
Timezone hint. When provided it overrides timezone field, but only if it's correct. If it's incorrect, the value is ignored.
Example: "(GMT-05:00) Eastern Time"
Valid when: timezone_hint's length doesn't exceed 50 characters
Whether tipping orders is enabled or not
Example: false
Maximum amount for tips in shop's default currency, the default is 1000 in major currency unit (e.g. 1000 USD)
Example: 1000
Valid when: tips_max is a non-negative integer
Tipping presets, must be valid percentages
Product variant to be used as "tips" line item
Valid when: tips_variant_id matches regexp pattern: ^va_
Result
Preview (typescript)
Loading module