Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

8.2 KB
Raw Blame
<Expandable title="properties">
  <ResponseField name="id" type="integer">
    Theme ID
    Example: 1
  </ResponseField>

  <ResponseField name="name" type="string">
    Theme name
    Example: `Winter Sale Theme`
  </ResponseField>

  <ResponseField name="preferred_checkout_sidebar_text_color" type="string">
    Checkout sidebar text color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_custom_font_code" type="string">
    Custom font code
    Example: `@import url('https://fonts.googleapis.com/css2?family=Inter&display=swap');`
  </ResponseField>

  <ResponseField name="preferred_font_family" type="string">
    Font family
    Example: `Inter`
  </ResponseField>

  <ResponseField name="preferred_font_size_scale" type="integer">
    Font size scale
    Example: `100`
  </ResponseField>

  <ResponseField name="preferred_header_font_family" type="string">
    Header font family
    Example: `Inter`
  </ResponseField>

  <ResponseField name="preferred_header_font_size_scale" type="integer">
    Header font size scale
    Example: `100`
  </ResponseField>

  <ResponseField name="preferred_headings_uppercase" type="boolean">
    Headings uppercase
    Example: `true`
  </ResponseField>

  <ResponseField name="preferred_button_border_thickness" type="integer">
    Button border thickness
    Example: `1`
  </ResponseField>

  <ResponseField name="preferred_button_border_opacity" type="integer">
    Button border opacity
    Example: `100`
  </ResponseField>

  <ResponseField name="preferred_button_border_radius" type="integer">
    Button border radius
    Example: `100`
  </ResponseField>

  <ResponseField name="preferred_button_shadow_opacity" type="integer">
    Button shadow opacity
    Example: `0`
  </ResponseField>

  <ResponseField name="preferred_button_shadow_horizontal_offset" type="integer">
    Button shadow horizontal offset
    Example: `0`
  </ResponseField>

  <ResponseField name="preferred_button_shadow_vertical_offset" type="integer">
    Button shadow vertical offset
    Example: `4`
  </ResponseField>

  <ResponseField name="preferred_button_shadow_blur" type="integer">
    Button shadow blur
    Example: `5`
  </ResponseField>

  <ResponseField name="preferred_input_border_thickness" type="integer">
    Input border thickness
    Example: `1`
  </ResponseField>

  <ResponseField name="preferred_input_border_opacity" type="integer">
    Input border opacity
    Example: `100`
  </ResponseField>

  <ResponseField name="preferred_input_border_radius" type="integer">
    Input border radius
    Example: `8`
  </ResponseField>

  <ResponseField name="preferred_input_shadow_opacity" type="integer">
    Input shadow opacity
    Example: `0`
  </ResponseField>

  <ResponseField name="preferred_input_shadow_horizontal_offset" type="integer">
    Input shadow horizontal offset
    Example: `0`
  </ResponseField>

  <ResponseField name="preferred_input_shadow_vertical_offset" type="integer">
    Input shadow vertical offset
    Example: `4`
  </ResponseField>

  <ResponseField name="preferred_input_shadow_blur" type="integer">
    Input shadow blur
    Example: `5`
  </ResponseField>

  <ResponseField name="preferred_border_width" type="integer">
    Border width
    Example: `1`
  </ResponseField>

  <ResponseField name="preferred_border_radius" type="integer">
    Border radius
    Example: `6`
  </ResponseField>

  <ResponseField name="preferred_border_shadow_opacity" type="integer">
    Border shadow opacity
    Example: `0`
  </ResponseField>

  <ResponseField name="preferred_border_shadow_horizontal_offset" type="integer">
    Border shadow horizontal offset
    Example: `0`
  </ResponseField>

  <ResponseField name="preferred_border_shadow_vertical_offset" type="integer">
    Border shadow vertical offset
    Example: `4`
  </ResponseField>

  <ResponseField name="preferred_border_shadow_blur" type="integer">
    Border shadow blur
    Example: `5`
  </ResponseField>

  <ResponseField name="preferred_product_listing_image_height" type="integer">
    Product listing image height
    Example: `300`
  </ResponseField>

  <ResponseField name="preferred_product_listing_image_width" type="integer">
    Product listing image width
    Example: `300`
  </ResponseField>

  <ResponseField name="preferred_product_listing_image_height_mobile" type="integer">
    Product listing image height mobile
    Example: `190`
  </ResponseField>

  <ResponseField name="preferred_product_listing_image_width_mobile" type="integer">
    Product listing image width mobile
    Example: `190`
  </ResponseField>

  <ResponseField name="preferred_primary_color" type="string">
    Primary color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_accent_color" type="string">
    Accent color
    Example: `#F0EFE9`
  </ResponseField>

  <ResponseField name="preferred_danger_color" type="string">
    Danger color
    Example: `#C73528`
  </ResponseField>

  <ResponseField name="preferred_neutral_color" type="string">
    Neutral color
    Example: `#999999`
  </ResponseField>

  <ResponseField name="preferred_background_color" type="string">
    Background color
    Example: `#FFFFFF`
  </ResponseField>

  <ResponseField name="preferred_text_color" type="string">
    Text color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_success_color" type="string">
    Success color
    Example: `#00C773`
  </ResponseField>

  <ResponseField name="preferred_button_background_color" type="string">
    Button background color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_button_text_color" type="string">
    Button text color
    Example: `#ffffff`
  </ResponseField>

  <ResponseField name="preferred_button_hover_background_color" type="string">
    Button hover background color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_button_hover_text_color" type="string">
    Button hover text color
    Example: `#ffffff`
  </ResponseField>

  <ResponseField name="preferred_button_border_color" type="string">
    Button border color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_border_color" type="string">
    Border color
    Example: `#E9E7DC`
  </ResponseField>

  <ResponseField name="preferred_sidebar_border_color" type="string">
    Sidebar border color
    Example: `#E9E7DC`
  </ResponseField>

  <ResponseField name="preferred_secondary_button_background_color" type="string">
    Secondary button background color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_secondary_button_text_color" type="string">
    Secondary button text color
    Example: `#ffffff`
  </ResponseField>

  <ResponseField name="preferred_secondary_button_hover_background_color" type="string">
    Secondary button hover background color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_secondary_button_hover_text_color" type="string">
    Secondary button hover text color
    Example: `#ffffff`
  </ResponseField>

  <ResponseField name="preferred_input_text_color" type="string">
    Input text color
    Example: `#6b7280`
  </ResponseField>

  <ResponseField name="preferred_input_background_color" type="string">
    Input background color
    Example: `#ffffff`
  </ResponseField>

  <ResponseField name="preferred_input_border_color" type="string">
    Input border color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_input_focus_border_color" type="string">
    Input focus border color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_input_focus_background_color" type="string">
    Input focus background color
    Example: `#ffffff`
  </ResponseField>

  <ResponseField name="preferred_input_focus_text_color" type="string">
    Input focus text color
    Example: `#000000`
  </ResponseField>

  <ResponseField name="preferred_checkout_sidebar_background_color" type="string">
    Checkout sidebar background color
    Example: `#f3f4f6`
  </ResponseField>

  <ResponseField name="preferred_checkout_divider_background_color" type="string">
    Checkout divider background color
    Example: `#f3f4f6`
  </ResponseField>

  <ResponseField name="preferred_checkout_sidebar_text_color" type="string">
    Checkout sidebar text color
    Example: `#000000`
  </ResponseField>  
</Expandable>