Skip to content

Latest commit

 

History

History
67 lines (59 loc) · 2.11 KB

checkout-location-settings.md

File metadata and controls

67 lines (59 loc) · 2.11 KB

Checkout Location Settings

Structure

CheckoutLocationSettings

Fields

Name Type Tags Description
locationId string | null | undefined Optional The ID of the location that these settings apply to.
customerNotesEnabled boolean | null | undefined Optional Indicates whether customers are allowed to leave notes at checkout.
policies CheckoutLocationSettingsPolicy[] | null | undefined Optional Policy information is displayed at the bottom of the checkout pages.
You can set a maximum of two policies.
branding CheckoutLocationSettingsBranding | undefined Optional -
tipping CheckoutLocationSettingsTipping | undefined Optional -
coupons CheckoutLocationSettingsCoupons | undefined Optional -
updatedAt string | undefined 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

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"
    }
  }
}