POST:shops/settings.json

Description

Modify shop settings.

Permission bit: "shop_settings.modify"

Topic: Shops

Query Parameters

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

ShopSettingsCreate

Copy
{
  "address_verification": false,
  "address_verification_auto": false,
  "auto_close": false,
  "auto_fulfill": false,
  "auto_reserve_subscription": false,
  "billing_address": {
    "address1": "Chestnut Street 92",
    "address2": "Apartment 2",
    "city": "Louisville",
    "company": "Google inc.",
    "country": "US",
    "id": "ad_EQzGqWoY",
    "name": "John Smith",
    "phone": "5556251199",
    "plus_code": "PQ7W+WM",
    "province": "KY",
    "zip": "40202"
  },
  "consistent_prices": true,
  "custom_invoice_text": "",
  "customer_can_pause_subscription": true,
  "customer_can_skip_subscription": true,
  "customer_oauth_providers": [
    {
      "client_id": "",
      "client_secret": "",
      "kind": "apple"
    }
  ],
  "customer_service_email": "iwanbk-shop@apple.com",
  "customer_webauthn": false,
  "default_tax_rule_id": "tr_EQzGqWoY",
  "gift_card_enabled": false,
  "gift_card_expiration_seconds": 86400,
  "indirect": false,
  "industry": "accessories",
  "invoice_due_date_days": 7,
  "language": "",
  "languages": [
    ""
  ],
  "name": "Apple Computers",
  "notification_email": "john@smith.com",
  "notifications": {
    "auth_order_notification": false,
    "email_abandoned_checkout": false,
    "email_favorite_inventory": false,
    "email_order_canceled": false,
    "email_order_confirmation": false,
    "email_product_review_reminder": false,
    "email_purchase_order": false,
    "email_refund_notification": false,
    "email_return_approved": false,
    "email_return_created": false,
    "email_return_rejected": false,
    "email_shipping_confirmation_digital_good": false,
    "email_shipping_confirmation_gift_card": false,
    "email_shipping_confirmation_physical": false,
    "email_shipping_update": false,
    "email_tracking_attempt_fail": false,
    "email_tracking_available_for_pickup": false,
    "email_tracking_delivered": false,
    "email_tracking_exception": false,
    "email_tracking_in_transit": false,
    "email_tracking_info_received": false,
    "email_tracking_out_for_delivery": false,
    "email_tracking_unknown": false,
    "new_order_notification": false,
    "new_return_notification": false,
    "sms_fulfillment_created": false,
    "sms_tracking_attempt_fail": false,
    "sms_tracking_available_for_pickup": false,
    "sms_tracking_delivered": false,
    "sms_tracking_out_for_delivery": false,
    "sms_tracking_unknown": false,
    "variant_low_stock": false
  },
  "on_hold_order_window_minutes": 5,
  "order_risk_cancel_threshold": 0.7,
  "order_risk_warning_threshold": 0.15,
  "prefer_twenty_four_hour": "auto",
  "previous_service": "big_commerce",
  "product_review_enabled": false,
  "revenue": "dont_know_yet",
  "round_tax_at": "jurisdiction",
  "send_abandoned_email_after_seconds": 54346,
  "send_abandoned_email_min_price": 0,
  "sender_email": "no-reply@apple.com",
  "shipping_tax_class": "",
  "shipping_tax_method": "custom",
  "start_number": 1000,
  "subscription_retries_schedule": [
    5
  ],
  "subscription_retries_schedule_daily": [
    5
  ],
  "subtotal_includes_tax": false,
  "tax_based_on": "billing_address",
  "tax_inclusive_prices": false,
  "tax_label": "Sale Tax",
  "timezone": "(GMT-05:00) Eastern Time",
  "timezone_hint": "(GMT-05:00) Eastern Time",
  "tips_enabled": false,
  "tips_max": 1000,
  "tips_presets": [
    3.1415
  ],
  "tips_variant_id": ""
}

Response Body

ShopSettings

Response Body Type

Loading module