Skip to content

Latest commit

 

History

History
93 lines (85 loc) · 1.92 KB

retrieve-location-settings-response.md

File metadata and controls

93 lines (85 loc) · 1.92 KB

Retrieve Location Settings Response

Structure

RetrieveLocationSettingsResponse

Fields

Name Type Tags Description
Errors IList<Error> Optional Any errors that occurred during the request.
LocationSettings CheckoutLocationSettings Optional -

Example (as JSON)

{
  "location_settings": {
    "branding": {
      "button_color": "#ffffff",
      "button_shape": "ROUNDED",
      "header_type": "FRAMED_LOGO"
    },
    "customer_notes_enabled": true,
    "location_id": "LOCATION_ID_1",
    "policies": [
      {
        "description": "This is my Return Policy",
        "title": "Return Policy",
        "uid": "POLICY_ID_1"
      }
    ],
    "tipping": {
      "default_percent": 15,
      "default_whole_amount_money": {
        "amount": 100,
        "currency": "USD"
      },
      "percentages": [
        10,
        15,
        20
      ],
      "smart_tipping_enabled": true,
      "whole_amounts": [
        {
          "amount": 1000,
          "currency": "USD"
        },
        {
          "amount": 1500,
          "currency": "USD"
        },
        {
          "amount": 2000,
          "currency": "USD"
        }
      ],
      "smart_tips": [
        {
          "amount": 152,
          "currency": "USN"
        },
        {
          "amount": 152,
          "currency": "USN"
        }
      ],
      "default_smart_tip": {
        "amount": 58,
        "currency": "XTS"
      }
    },
    "updated_at": "2022-06-16T22:25:35Z"
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    },
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}