post

/banners

Creates a Banner.

Required Fields

  • name
  • content
  • page
  • location
  • date_type

Read Only Fields

  • date_created
  • id

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

2 Headers

Request Body

1 Example
Schema
object
name
string

Name of the banner.

1 validation + required
content
string

Contains the banner content. Returned as a string and includes HTML formatting.

1 validation + required
page
string

Page the Banner is located on.

1 validation + required
location
string

Location on the page.

2 validations + required
date_type
string

This specifies whether the banner should be visible during a specific date range.

1 validation + required
date_from
string

If the datetype is set as 'custom’, this field specifies the date when the banner should become visible on the storefront.

1 validation
date_to
string

If the datetype is set as 'custom’, this field specifies the date when the banner should stop being visible on the storefront.

1 validation
visible
string

Integer value denoting whether or not the banner is visible on the storefront: 1 = visible; 0 = not visible

1 validation

Responses

1 Example
Schema
object
id
integer

Id of the banner. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

1 validation
date_created
string

Date the banner is created.

2 validations
item_id
string

If the banner is on a specific category or brand page then the item_id will correspond the category or brand id.

1 validation
name
string

Name of the banner.

1 validation + required
content
string

Contains the banner content. Returned as a string and includes HTML formatting.

1 validation + required
page
string

Page the Banner is located on.

1 validation + required
location
string

Location on the page.

2 validations + required
date_type
string

This specifies whether the banner should be visible during a specific date range.

1 validation + required
date_from
string

If the datetype is set as 'custom’, this field specifies the date when the banner should become visible on the storefront.

1 validation
date_to
string

If the datetype is set as 'custom’, this field specifies the date when the banner should stop being visible on the storefront.

1 validation
visible
string

Integer value denoting whether or not the banner is visible on the storefront: 1 = visible; 0 = not visible

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client