v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB

Theming

List Themes

get/v2/theme

Query parameters

searchstring

Filter themes using RSQL syntax. Combine expressions with ; (AND) or , (OR).

Filterable fields:

Field	Type	Operators
name	string	== != =in= =out= =regex= =contains=
created_at	date	== != =in= =out= =gt= =ge= =lt= =le=
updated_at	date	== != =in= =out= =gt= =ge= =lt= =le=
entity_id	string	== != =in= =out= =regex=
is_default	boolean	== !=

Examples:

name==MyTheme;entity_id==a6b45428-0296-4394-8ddd-0b50b5b20aa9
is_default==true

order_criteria'name' | 'created_at' | 'updated_at'

order_by'ASC' | 'DESC'

The ordering sequence of the selected customers If not selected then Descending order is the default order.

page_numbernumber

A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.

page_sizenumber

A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50

populate_customer_detailsboolean

A query param to allow customer details to be populated for the customer id attached to checkout.

Response

Successful

namestring required

logostring

Uploaded image Id

entity_idstring

Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)

base_font_family'Roboto' | 'Open Sans' | 'Lato' | 'Slabo' | 'Oswald' | 'Source Sans Pro' | 'Montserrat' | 'Raleway' | 'PT Sans' | 'Lora' | 'Noto Sans' | 'Noto Serif' | 'Nunito Sans' | 'Concert One' | 'Prompt' | 'Work Sans'

base fonts available for theme

text_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

heading_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

background_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

panel_background_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

primary_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

primary_color_inversestring

6 digit hex code, e.g. <code>ffe0e0</code>

primary_color_disabledstring

6 digit hex code, e.g. <code>ffe0e0</code>

primary_color_inverse_disabledstring

6 digit hex code, e.g. <code>ffe0e0</code>

error_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

error_color_inversestring

6 digit hex code, e.g. <code>ffe0e0</code>

input_border_radiusnumber

input_border_widthnumber

hide_verifone_sealboolean

Show/Hide verifone seal on the checkout page

idstring

created_atstring date

updated_atstring date