oont-contents/plugins/woocommerce-square/vendor/square/square/doc/models/checkout-location-settings.md
2025-02-08 15:10:23 +01:00

2.6 KiB

Checkout Location Settings

Structure

CheckoutLocationSettings

Fields

Name Type Tags Description Getter Setter
locationId ?string Optional The ID of the location that these settings apply to. getLocationId(): ?string setLocationId(?string locationId): void
customerNotesEnabled ?bool Optional Indicates whether customers are allowed to leave notes at checkout. getCustomerNotesEnabled(): ?bool setCustomerNotesEnabled(?bool customerNotesEnabled): void
policies ?(CheckoutLocationSettingsPolicy[]) Optional Policy information is displayed at the bottom of the checkout pages.
You can set a maximum of two policies.
getPolicies(): ?array setPolicies(?array policies): void
branding ?CheckoutLocationSettingsBranding Optional - getBranding(): ?CheckoutLocationSettingsBranding setBranding(?CheckoutLocationSettingsBranding branding): void
tipping ?CheckoutLocationSettingsTipping Optional - getTipping(): ?CheckoutLocationSettingsTipping setTipping(?CheckoutLocationSettingsTipping tipping): void
coupons ?CheckoutLocationSettingsCoupons Optional - getCoupons(): ?CheckoutLocationSettingsCoupons setCoupons(?CheckoutLocationSettingsCoupons coupons): void
updatedAt ?string Optional The timestamp when the settings were last updated, in RFC 3339 format.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
getUpdatedAt(): ?string setUpdatedAt(?string updatedAt): void

Example (as JSON)

{
  "location_id": "location_id4",
  "customer_notes_enabled": false,
  "policies": [
    {
      "uid": "uid8",
      "title": "title4",
      "description": "description8"
    },
    {
      "uid": "uid8",
      "title": "title4",
      "description": "description8"
    }
  ],
  "branding": {
    "header_type": "FULL_WIDTH_LOGO",
    "button_color": "button_color2",
    "button_shape": "PILL"
  },
  "tipping": {
    "percentages": [
      246,
      247
    ],
    "smart_tipping_enabled": false,
    "default_percent": 46,
    "smart_tips": [
      {
        "amount": 152,
        "currency": "USN"
      },
      {
        "amount": 152,
        "currency": "USN"
      }
    ],
    "default_smart_tip": {
      "amount": 58,
      "currency": "XTS"
    }
  }
}