REST Specification

January 31, 2018 (rev 01.31.18)

1 Basic Information

1.1 Records

Records are the collection of data about a single item. Record types include Publication and Issue, for example. A list of the fields in each record type is located in section 3.

1.2 Fields

A field is a single item of data in a record.

If a field has a list of options, they will be listed as such:

Key => Description

When sending data for a field, only send the Key. When retrieving data for a field, only the Key will be sent.

1.3 Actions

The normal REST actions are supported:

  • GET  Retrieve a record
  • PUT  Updated a record
  • POST  Create a record
  • DELETE  Remove a record

Not all actions are supported for all record types. Section 3 of this document details which record types do not support certain actions.


2 Basic Usage

2.1 REST Endpoint

Base URL: https://www.mydigitalpublication.com/rest/rest.php

Example Request: https://www.mydigitalpublication.com/rest/rest.php/publication/1

All returns will have a status code indicating the result, a text description, and optionally data that is being returned. The authenticate request will also set cookies. All other requests require that the authentication cookie exist and be valid for the request.

By default, returned data is in JSON format. If requested (format=xml) then XML can be returned. Example XML Request: https://www.mydigitalpublication.com/rest/rest.php/publication/1?format=xml

2.2 Authentication

2.2.1 Authenticate as Publisher

POST /authenticate

Will authenticate with the posted information and return a status code and cookie accordingly.

To authenticate, username, password and publisher_id will need to be sent.

  • Success:
    • Status code 204 with an empty body and a cookie.
  • Failure:
    • Status code 403 with an error message in JSON or XML in the body.
  • POST:
    • username: xxx
    • password: xxx
    • publisher_id: xxx
  • CURL:
curl -v https://www.mydigitalpublication.com/rest/rest.php/authenticate \
-b /tmp/restcookies -c /tmp/restcookies -X POST \
-F 'username=xxx' -F 'password=xxx' -F 'publisher_id=xxx'

2.2.2 Authenticate as VAR

POST /authenticate

Will authenticate with the posted information and return a status code and cookie accordingly.

To authenticate, username and password will need to be sent.

  • Success:
    • Status code 204 with an empty body and a cookie.
  • Failure:
    • Status code 403 with an error message in JSON or XML in the body.
  • POST:
    • username: xxx
    • password: xxx
  • CURL:
curl -v https://www.mydigitalpublication.com/rest/rest.php/authenticate/printer \
-b /tmp/restcookies -c /tmp/restcookies -X POST \
-F 'username=xxx' -F 'password=xxx'

2.3 Information About A Record Type

If you need information about a specific record type, such as what fields are available or required, send the a request via the method to the URL without the ID or any data.

GET /publication

Retrieve information about retrieving Publication records, including what fields will be returned and what child records are available for retrieval.

PUT /publication

Retrieve information about updating Publication records, including possible values for fields.

POST /publication

Retrieve information about creating Publication records, including what fields are required and possible values

DELETE /publication

Retrieve information about deleting Publication records.

2.4 Retrieving Records

2.4.1 Single Records

GET /publication/1

Will retrieve data for publication with ID 1 in JSON (default) format.

JSON:

{
 "publication":{
  "id":"1",
  "name":"First Publication",
  "url":"http://example.com",
 }
}

2.4.1.1 Additional Examples

GET /issue/123

Will retrieve data for issue with ID 123.

GET /page/123456

Will retrieve data for page with ID 123456

GET /rollover/1234567

Will retrieve data for rollover/offer with ID 1234567

As a special exception, publishers can use 'self' as the ID for retrieving information about their own publisher record, such as /publisher/1234 or /publisher/self. Likewise, VARs can use 'self' for their own VAR record. This also applies to getting the child records (see below) of their own record.

2.4.2 XML Format

GET /publication/1?format=xml

Will retrieve data for publication with ID 1 in XML format.

XML:

<?xml version="1.0" encoding="UTF-8"?>
<publication id="1">
 <name>First Publication</name>
 <url>http://www.example.com</url>
</publication>

2.5 Child Records

GET /publication/1/issues

Will retrieve issues for the publication with ID 1.

JSON:

{
 "issues":{
  "1":{
   "id":"1",
   "name":"First Issue",
   },
  "2":{
   "id":"2",
   "name":"Second Issue",
  }
 }
}

2.5.1 Additional Examples

GET /issue/123/pages

Will retrieve pages for the issue with ID 123

GET /issue/456/virtualpages

Will retrieve virtual pages for the issue with ID 456

GET /page/123456/rollovers

Will retrieve rollover/offers for the page with ID 123456

GET /rollover/1234567/skus

Will retrieve skus for the rollover/offer with ID 1234567

2.6 Creating Records

POST /publication

Will create new publication and return ID created in JSON (default) or XML format.

If default values have been set, those values will be used for any fields that are not explicitly set in the

POST.

POST:

name=New%20Publication
url=http%3A%2F%2Fexample.com

JSON:

{
 "success":{
  "location":"/publication/1"
  }
}

XML:

<?xml version="1.0"?>
<success>
 <location>/publication/1</location>
</success>

2.7 Changing Records

PUT /publication/1

Will update an existing publication. Only status code is returned. Should return 204 (No Content) for success.

POST:

name=Changed%20Name

2.8 Removing Records

DELETE /issue/1

Will delete an existing issue. Only status code is returned. Should return 204 (No Content) for success.

2.9 Supported Objects

Publication and Issue are the only 2 records supported so far. In addition, Issue PDFs can be uploaded for conversion.

2.10 File/Image Uploads

File and image uploads are not yet supported for records.

Posting the file with the name of the field as the field name will upload that file appropriately.

For example, to upload the issue's 'logo' and change the name of the issue:

curl -v -b /tmp/restcookies -c /tmp/restcookies \
https://www.mydigitalpublication.com/rest/rest.php/issue/1 -X PUT \
-F "name=New%20Name" \
-F logo=@/path/to/logo.png

2.11 Issue PDF Conversion Status

GET /issueupload/1

Check the status of the conversion of an issue.

2.12 Uploading Issue PDFs for Conversion

To upload a set of PDFs for conversion, POST it to /issueupload/1 with '1' being the Issue ID to upload for. If there is already an issue queued for conversion, you will not be able to upload another. The names of the fields ('pdf1', 'pdf2', 'pdf3' in the example) do not matter, so long as they are different from each other.

Unlike file/image uploads for records, this feature is already supported.

POST /issueupload/1

Upload multiple PDFs as a set for processing.

curl -v -b /tmp/restcookies -c /tmp/restcookies \
https://www.mydigitalpublication.com/rest/rest.php/issueupload/1 \
-X POST \
-F pdf1=@/path/to/first.pdf \
-F pdf2=@/path/to/second.pdf \
-F pdf3=@/path/to/third.pdf \
-F conversion_type=3

2.13 Uploading PDFs for Presentation Pages

Single-page PDFs can be uploaded as presentation pages for the issue. The ID in the URL is the ID of the issue to set the presentation page for. To update the first page, post the variable 'page' with the value 'first', as show below. To update the last page, post the variable 'page' with the value 'last'. You can only update 1 page in a single request. To update 2 pages, send 2 requests, 1 for each page.

POST /presentationpageupload/1

Upload a single-page PDF to use as the first or last presentation page.

curl -b /tmp/restcookies -c /tmp/restcookies \
https://www.mydigitalpublication.com/rest/rest.php/presentationpageupload/1 \
-X POST \
-F pdf=@/path/to/page.pdf \
-F conversion_type=3 \
-F page=first

2.14 Activating an Issue

Issues can be activated by:

PUT /issue/activate/1

Activate the issue with ID specified.

curl -b /tmp/restcookies -c /tmp/restcookies \
https://www.mydigitalpublication.com/rest/rest.php/issue/activate/1 \
-X PUT \
-F activate=true

Note that PUT requests require some data to be valid. In the sample request, we sent 'activate' as 'true', but any data at all would have worked.

Issues cannot be de-activated via this API.

2.15 Multi-Requests

For convenience, multiple requests of the same type can often be performed simultaneously. If any of the requests fail, they will all fail and no changes will be made. Some record types may not allow multi-requests and that will be stated in their unsupported actions.

2.15.1 Multiple IDs

When submitting a multi-request, any ID numbers are listed in the URL as such:

PUT /issue/multi/15/26/38

curl -b /tmp/restcookies -c /tmp/restcookies \
https://www.mydigitalpublication.com/rest/rest.php/issue/multi/15/26/38 \
-X PUT \
-F dock=1 \
-F name1=New%20Issue \
-F language_id3=7

The above will send edits to ID 15, 26 and 38. Any fields posted with numbers (e.g. name1, language_id3) will only apply to the record in that position. In the above example, dock would apply to records with IDs 15, 26 and 38, name1 would apply to the record with ID 15, and language_id3 would apply to the record with ID 38.

2.15.2 Requests without IDs

For requests that don't take IDs (e.g. POST), the number of records created will depend on the amount of unique information sent.

POST /issue/multi

curl -b /tmp/restcookies -c /tmp/restcookies \
https://www.mydigitalpublication.com/rest/rest.php/issue/multi \
-X POST \
-F name1=New%20Issue \
-F name2=New%20Issue%202 \
-F name3=New%20Issue%203

The above would create 3 new records. (There are other required fields for new issues, which have been left out for brevity.)

2.15.3 Responses

Responses without data will still be the same and will return the expected error codes.

Responses with validation errors will return validation for each record.

Other errors will remain the same.

Responses that return data will return the data for each record affected.


3 Record Types

3.1 Publication

3.1.1 Unsupported Actions

DELETE  Publications cannot be removed.

3.1.2 Fields

  • Name: id
  • Label: ID
  • Read Only: Yes
  • Required: No

 

  • Name: type
  • Label: Publication Type
  • Read Only: No
  • Required: Yes
  • Default Value: Catalog
  • Options:
  • Book => Book
  • Catalog => Catalog
  • Circular => Circular
  • Flyer => Flyer
  • Magazine => Magazine
  • Newsletter => Newsletter
  • Newspaper => Newspaper
  • Resume/Portfolio => Resume/Portfolio
  • Reference => Reference
  • Other => Other

 

  • Name: name
  • Label: Publication Name
  • Read Only: No
  • Required: Yes

 

  • Name: category_id
  • Label: Category
  • Read Only: No
  • Required: Yes
  • Options:
  • 141 =>
  • 110 => Alternative
  • 111 => Architecture & Construction
  • 1 => Art & Photography
  • 112 => Arts & Crafts
  • 113 => Boating & Aviation
  • 22 => Business & Finance
  • 12 => Cars & Bikes
  • 13 => Children
  • 114 => Clothing & Accessories
  • 34 => Comics, Puzzles & Games
  • 15 => Computers & Tech
  • 115 => Coupons
  • 92 => Education
  • 17 => Electronics & Audio
  • 18 => Entertainment
  • 19 => Ethnic
  • 20 => Family & Parenting
  • 21 => Fashion & Style
  • 116 => Fiction
  • 16 => Food & Beverage
  • 117 => Furniture
  • 118 => Gay & Lesbian
  • 24 => General & Various Interests
  • 14 => Gifts & Collectibles
  • 119 => Gourmet Gifts & Foods
  • 120 => Grocery
  • 25 => Health & Fitness
  • 121 => History
  • 26 => Hobbies
  • 23 => Home & Garden
  • 106 => Home Décor
  • 122 => Jewelry
  • 123 => Kitchen & Housewares
  • 124 => Leisure
  • 125 => Luxury
  • 126 => Manufacturing
  • 127 => Mature
  • 128 => Men & Women's Apparel
  • 28 => Men's Interest
  • 29 => Music
  • 6 => News
  • 140 => Newsletters
  • 129 => Non-Fiction
  • 130 => Office Equipment & Furniture
  • 131 => Office Supplies
  • 132 => Other
  • 30 => Outdoor
  • 8 => Pets & Animals
  • 90 => Real Estate
  • 134 => Religion
  • 35 => Science & Nature
  • 135 => Science Fiction & Fantasy
  • 136 => Self
  • 137 => Shoes
  • 138 => Special Interest
  • 36 => Sports & Leisure
  • 37 => Teen
  • 144 => test
  • 139 => Trade & Association
  • 109 => Travel & Regional
  • 38 => Weddings & Bridal
  • 39 => Women's Interest

 

  • Name: circulation
  • Label: Circulation
  • Read Only: No
  • Required: Yes
  • Default Value: 1

 

  • Name: default_host_id
  • Label: Default Domain
  • Read Only: No
  • Required: Yes
  • Default Value: 36
  • Options:
  • (A list of domains available to you)

 

  • Name: language_id
  • Label: Language
  • Read Only: No
  • Required: Yes
  • Default Value: 1
  • Options:
  • 1 => English (US)
  • 3 => Español
  • 4 => Français

 

  • Name: notifications_email
  • Label: Notifications Email
  • Read Only: No
  • Required: No
  • Default Value: (defaults to contact's email)

 

  • Name: iphone_new_notice
  • Label: Enable Push Notifications
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: push_notification_message
  • Label: Push Notification Message
  • Read Only: No
  • Required: No

 

  • Name: right_to_left
  • Label: Right-to-left (Mobile Apps Only)
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: news_url
  • Label: iPad/iPhone News Link
  • Read Only: No
  • Required: No

 

  • Name: url
  • Label: Publication Website
  • Read Only: No
  • Required: No

 

  • Name: logo_description
  • Label: Publication Custom Logo Description
  • Read Only: No
  • Required: No

 

  • Name: publishfrequency
  • Label: Publish Frequency
  • Read Only: No
  • Required: Yes
  • Default Value: 5
  • Options:
  • 5 => Daily (365x per year)
  • 6 => Weekly (52x per year)
  • 7 => Bi-Weekly (26x per year)
  • 8 => Semi-Monthly (24x per year)
  • 9 => Monthly (12x per year)
  • 10 => Bi-Monthly (6x per year)
  • 11 => Quarterly (4x per year)
  • 12 => Semi-Annually (2x per year)
  • 13 => Annually (1x per year)
  • 14 => Single Issue
  • 15 => 8x per year
  • 16 => 3x per year

 

  • Name: archive_sidebar
  • Label: Archive Sidebar
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => None
  • 1 => Right
  • 2 => Left
  • 3 => Bottom
  • 4 => Top

 

  • Name: sidebar_title
  • Label: Sidebar Title
  • Read Only: No
  • Required: No

 

  • Name: sidebar_title_hex
  • Label: Sidebar Title Color
  • Read Only: No
  • Required: No
  • Default Value: 000000

 

  • Name: sidebar_element_hex
  • Label: Sidebar Element Color
  • Read Only: No
  • Required: No
  • Default Value: 0000FF

 

  • Name: news
  • Label: iPad/iPhone News Title
  • Read Only: No
  • Required: No

 

  • Name: news_icon
  • Label: iPad/iPhone News Icon
  • Read Only: No
  • Required: No

3.2 Issue

3.2.1 Set Virtual Pages

PUT /issue/1/setvirtualpages

This is a special function for virtual issues only. Will replace all the virtual pages at the same time. Only status code is returned. Should return 204 (No Content) for success. Page IDs are specified by using page_id and an incrementing number. Other information, such as page names and whether a page is a presentation page, is specified with the appropriate label and the same number as the page that it applies to. See example below. Current fields are page_id, page_name, and presentation_page.

POST:

  • page_id1=123
  • page_id2=456
  • page_id3=789
  • presentation_page3=1
  • page_name2=test

3.2.2 Fields

  • Name: id
  • Label: Id
  • Read Only: Yes
  • Required: No

 

  • Name: publication_id
  • Label: Publication Name
  • Read Only: After Creation
  • Required: Yes
  • Options:
  • (A list of your publications)

 

  • Name: name
  • Label: Issue Name
  • Read Only: No
  • Required: Yes

 

  • Name: active
  • Label: Active
  • Read Only: Yes
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: issue_code
  • Label: Purchase Order/Issue Code
  • Read Only: No
  • Required: No

 

  • Name: date
  • Label: Date
  • Read Only: No
  • Required: Yes

 

  • Name: description
  • Label: Issue Description
  • Read Only: No
  • Required: No

 

  • Name: helptype
  • Label: Help Type
  • Read Only: No
  • Required: Yes
  • Default Value: 2
  • Options:
  • 2 => Publish It Yourself
  • 1 => Setup Assistance
  • 4 => Rollover Setup Assistance
  • 9 => Publishers Package + Lily

 

  • Name: bgcolor
  • Label: Viewer Background Color
  • Read Only: No
  • Required: No
  • Default Value: FFFFFF

 

  • Name: method
  • Label: Background Display Method
  • Read Only: No
  • Required: Yes
  • Default Value: stretch
  • Options:
  • stretch => Stretched
  • tiled => Tiled

 

  • Name: link_color
  • Label: Default Link Color
  • Read Only: No
  • Required: No
  • Default Value: 0066FF

 

  • Name: help
  • Label: Viewer Help URL
  • Read Only: No
  • Required: No

 

  • Name: list_url
  • Label: Shopping List URL
  • Read Only: No
  • Required: No

 

  • Name: viewer_version_id
  • Label: Viewer Version
  • Read Only: No
  • Required: Yes
  • Default Value: 4
  • Options:
  • 4 => Flash Viewer 2.0
  • 1 => Flash Viewer
  • 2 => HTML Viewer

 

  • Name: enable_custom_dropdown
  • Label: Enable Custom Dropdown Button
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: custom_dropdown_name
  • Label: Custom Dropdown Name
  • Read Only: No
  • Required: No

 

  • Name: custom_dropdown_width
  • Label: Custom Dropdown Width
  • Read Only: No
  • Required: Yes
  • Default Value: 100
  • Options:
  • 100 => 100 Pixels
  • 300 => 300 Pixels

 

  • Name: custom_dropdown_type
  • Label: Custom Dropdown Style
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => List (Default)
  • 1 => Thumbnails
  • 3 => List Tree

 

  • Name: contents_width
  • Label: Contents Width
  • Read Only: No
  • Required: Yes
  • Default Value: 100
  • Options:
  • 100 => 100 Pixels
  • 300 => 300 Pixels

 

  • Name: contents_type
  • Label: Contents Style
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => List (Default)
  • 1 => Thumbnails
  • 3 => List Tree

 

  • Name: advertisers_type
  • Label: Advertisers Style
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => List (Default)
  • 1 => Thumbnails
  • 3 => List Tree

 

  • Name: zoom_type
  • Label: Zoom Style
  • Read Only: No
  • Required: Yes
  • Default Value: 1
  • Options:
  • 1 => Slider Zoom (Default)
  • 2 => Toggle Zoom

 

  • Name: custom_pdf_url
  • Label: Custom PDF URL
  • Read Only: No
  • Required: No

 

  • Name: invisible
  • Label: Do Not Include My Publication In The Coverstand Digital Library
  • Read Only: No
  • Required: No
  • Default Value: 1
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_printing
  • Label: Disable Page Printing
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_pdf
  • Label: Disable PDF Download
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_sendtofriend
  • Label: Disable "Send To Friend" Option
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_social_bookmark
  • Label: Disable Social Bookmarks
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_widget_btn
  • Label: Disable Widget Button
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: send_email
  • Label: Contact Email Address
  • Read Only: No
  • Required: No

 

  • Name: disable_rollover_sound
  • Label: Disable Rollover Sound
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_list_button
  • Label: Disable Shopping List
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_fonts
  • Label: Disable Fonts (For Non-Latin Characters)
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: show_shadow
  • Label: Enable Drop Shadow By Default
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: archive_disabled
  • Label: Disable Archives
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_contents
  • Label: Disable Contents
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_presentation_ios
  • Label: Disable Presentation Pages On IOS Devices
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_notes_button
  • Label: Disable Notes Button
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_autohidelink
  • Label: Disable Link Auto-Hiding
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_presentlinks
  • Label: Disable Link Visibility
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_loading_screen
  • Label: Disable Loading Screen
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: circular
  • Label: This Is A Circular
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: link_windows_on_zoom
  • Label: Enable Rollovers In Zoom Mode
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_page_animation
  • Label: Disable Page Animation
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: remove_side_arrows
  • Label: Remove Side Arrow Navigation
  • Read Only: No
  • Required: No
  • Default Value: true
  • Options:
  • true => No
  • false => Yes

 

  • Name: disable_flip_sound
  • Label: Disable Page Flipping Sound
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_thumbs_button
  • Label: Disable Thumbs Button
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_seo
  • Label: Disable Proactive SEO Initiatives
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_page_slope
  • Label: Disable Center Shadow By Default
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: right_to_left
  • Label: Right To Left Navigation (iPad/iPhone Only)
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: disable_advertisers
  • Label: Disable Advertisers
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: language_id
  • Label: Toolbar Language
  • Read Only: No
  • Required: Yes
  • Default Value: 1
  • Options:
  • 1 => English (US)
  • 8 => Español
  • 9 => Français

 

  • Name: dock
  • Label: Dock
  • Read Only: No
  • Required: Yes
  • Default Value: 42351

 

  • Name: toolbar_type
  • Label: Toolbar Type
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => Normal
  • 1 => Animated

 

  • Name: url
  • Label: Issue Url (Link for Viewer Issue Logo)
  • Read Only: No
  • Required: No

 

  • Name: logo_description
  • Label: Issue Custom Logo Description
  • Read Only: No
  • Required: No

 

  • Name: flip_style
  • Label: Flip Style
  • Read Only: No
  • Required: Yes
  • Default Value: 1
  • Options:
  • 1 => Original Recipe (default)
  • 2 => Extra Crispy

 

  • Name: single_page_only
  • Label: Default to Single Page View
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: search_issue_only
  • Label: Search Only This Issue
  • Read Only: After Creation
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: issue_url
  • Label: Issue URL
  • Read Only: Yes
  • Required: No

 

  • Name: issue_url_obfuscated
  • Label: Issue URL Obfuscated
  • Read Only: Yes
  • Required: No

3.3 Issue Upload

3.3.1 Fields

  • Name: pause
  • Label: Preview Before Data Entry
  • Read Only: No
  • Required: Yes
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: preserve_relative_size
  • Label: Preserve Relative Sizes of PDF Pages in Final Digital Edition
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: ipad_size
  • Label: Size for the iPad
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: conversion_type
  • Label: Conversion Type
  • Read Only: No
  • Required: Yes
  • Default Value: 3
  • Options:
  • 3 => Forced Full Vector
  • 2 => Raster
  • 1 => Optimized Vector

 

  • Name: send_email
  • Label: Please notify me via email at the address in notify_email when complete.
  • Read Only: No
  • Required: No
  • Default Value: 0

 

  • Name: notify_email
  • Label: Notify Email
  • Read Only: No
  • Required: No

 

  • Name: page_names
  • Label: Page Names
  • Read Only: No
  • Required: No
  • Default Value: 4
  • Options:
  • 1 => Preserve Page Names from PDFs
  • 2 => Cover, IFC, Page 1, Page 2, Page 3, ... IBC, BackCover
  • 3 => Cover1, Cover2, Page 1, Page 2, Page 3, ... Cover3, Cover4
  • 4 => Page 1, Page 2, Page 3, …

 

  • Name: uoc
  • Label: Use Old Converter
  • Read Only: No
  • Required: No
  • Default Value: 0

 

  • Name: completed_callback_url
  • Label: Completed Callback Url
  • Read Only: No
  • Required: No
  • Default Value:

 

  • Name: auto_activate
  • Label: Auto Activate
  • Read Only: No
  • Required: Yes
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: suppress_autolinking
  • Label: Suppress Autolinking
  • Read Only: No
  • Required: Yes
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: refry
  • Label: Refry
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

3.4 Page

3.4.1 Unsupported Actions

POST  Pages cannot be created.

DELETE  Pages cannot be removed.

3.4.2 Fields

  • Name: id
  • Label: Id
  • Read Only: Yes
  • Required: No

 

  • Name: issue_id
  • Label: Issue Id
  • Read Only: After Creation
  • Required: Yes

 

  • Name: internal_page_number
  • Label: Internal Page No
  • Read Only: Yes
  • Required: Yes

 

  • Name: name
  • Label: Name
  • Read Only: Yes
  • Required: No

 

  • Name: image_name
  • Label: Imagename
  • Read Only: Yes
  • Required: No

 

  • Name: bad_size
  • Label: Bad Size
  • Read Only: Yes
  • Required: No

 

  • Name: toc
  • Label: Toc
  • Read Only: Yes
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: v_pos
  • Label: Vpos
  • Read Only: Yes
  • Required: No

 

  • Name: h_pos
  • Label: Hpos
  • Read Only: Yes
  • Required: No

 

  • Name: audio_url
  • Label: Audio Url
  • Read Only: Yes
  • Required: No

 

  • Name: show_corners
  • Label: Showcorners
  • Read Only: Yes
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: rotation
  • Label: Rotation
  • Read Only: No
  • Required: Yes

 

  • Name: type
  • Label: Type
  • Read Only: Yes
  • Required: Yes

 

  • Name: type_sequence
  • Label: Type Sequence
  • Read Only: Yes
  • Required: Yes

 

  • Name: audio_end_ipn
  • Label: Audio End Ipn
  • Read Only: Yes
  • Required: Yes

 

  • Name: swf_height
  • Label: Swf Height
  • Read Only: Yes
  • Required: No

 

  • Name: swf_width
  • Label: Swf Width
  • Read Only: Yes
  • Required: No

 

  • Name: jpg_width
  • Label: Jpg Width
  • Read Only: Yes
  • Required: No

 

  • Name: jpg_height
  • Label: Jpg Height
  • Read Only: Yes
  • Required: No

3.5 Advertiser

In addition to the standard GET operation that retrieves info about a single record, advertisers have a special function that retrieves a list of every available advertiser for the publisher.

GET /Advertiser/all

3.5.1 Unsupported Actions

POST  Advertisers cannot be created.

PUT  Advertisers cannot be updated.

DELETE  Advertisers cannot be removed.

3.5.2 Fields

  • Name: id
  • Label: Id
  • Read Only: Yes
  • Required: No

 

  • Name: name
  • Label: Name
  • Read Only: No
  • Required: Yes

 

  • Name: url
  • Label: Url
  • Read Only: No
  • Required: No

 

  • Name: email
  • Label: Email
  • Read Only: No
  • Required: No

 

  • Name: phone
  • Label: Phone
  • Read Only: No
  • Required: No

 

  • Name: extension
  • Label: Extension
  • Read Only: No
  • Required: No

 

  • Name: publisher_id
  • Label: Publisher Id
  • Read Only: After Creation
  • Required: No

3.6 Link

3.6.1 Special Fields

The width_x, height_y, and pdf_* fields are special. They will set the start_* and end_* fields by means of calculations. Because of this, some rules have to be followed to use them:

Set the page_id first. The page must have already finished conversion.

Set the corresponding *start_* before using width or height.

Validation errors will happen to the start_* and end_* fields, not the special fields.

3.6.2 Link Types

3.6.2.1 Link

This is just a link to an outside site, usually an advertiser. As such, you should specify the advertiser, as well as the start and end coordinates and URL. The type is '1'.

3.6.2.2 Video

This is a link to a video. For now, you can only link to existing videos. Start and end coordinates and video_url should be specified. The type is '2'.

3.6.2.3 Business Reply Card

This is a form for the client to fill out. Name, form name, email (to send to), form color, and the 2 field names should be specified. The type is '10'.

3.6.2.4 HTML5 Overlay

This is a link to an HTML5 Resource (i.e. Animation) Manifest File. Provide start and end coordinates, page ID, and URL. The type is '19'.

3.6.3 Fields

  • Name: id
  • Label: ID
  • Read Only: Yes
  • Required: No

 

  • Name: page_id
  • Label: Page
  • Read Only: No
  • Required: Yes

 

  • Name: name
  • Label: Name
  • Read Only: No
  • Required: No

 

  • Name: url
  • Label: Url
  • Read Only: No
  • Required: Yes

 

  • Name: image_name
  • Label: Image Name
  • Read Only: Yes
  • Required: No
  • Default Value:

 

  • Name: start_x
  • Label: Start X
  • Read Only: No
  • Required: Yes

 

  • Name: start_y
  • Label: Start Y
  • Read Only: No
  • Required: Yes
  • Name: end_x
  • Label: End X
  • Read Only: No
  • Required: Yes

 

  • Name: end_y
  • Label: End Y
  • Read Only: No
  • Required: Yes

 

  • Name: width_x
  • Label: Width X
  • Read Only: No
  • Required: No

 

  • Name: height_y
  • Label: Height Y
  • Read Only: No
  • Required: No

 

  • Name: pdf_start_x
  • Label: PDF Start X
  • Read Only: No
  • Required: No

 

  • Name: pdf_start_y
  • Label: PDF Start Y
  • Read Only: No
  • Required: No

 

  • Name: pdf_end_x
  • Label: PDF End X
  • Read Only: No
  • Required: No

 

  • Name: pdf_end_y
  • Label: PDF End Y
  • Read Only: No
  • Required: No

 

  • Name: pdf_width_x
  • Label: PDF Width X
  • Read Only: No
  • Required: No

 

  • Name: pdf_height_y
  • Label: PDF Height Y
  • Read Only: No
  • Required: No

 

  • Name: email
  • Label: Email
  • Read Only: No
  • Required: No

 

  • Name: image_id
  • Label: Imageid
  • Read Only: No
  • Required: No

 

  • Name: color
  • Label: Color
  • Read Only: No
  • Required: No

 

  • Name: page_url
  • Label: Page URL
  • Read Only: No
  • Required: No

 

  • Name: title_id
  • Label: Title ID
  • Read Only: No
  • Required: No

 

  • Name: type
  • Label: Type
  • Read Only: No
  • Required: Yes
  • Options:
  • 1 => Link
  • 2 => Video
  • 10 => Business Reply Card

 

  • Name: video_name
  • Label: Video Name
  • Read Only: No
  • Required: No

 

  • Name: advertiser_id
  • Label: Advertiser
  • Read Only: No
  • Required: No
  • Options:
  • 3 => Test 3.1
  • 1 => Test Advertiser
  • 2 => Test2

 

  • Name: page_number
  • Label: Page Number
  • Read Only: No
  • Required: No

 

  • Name: status
  • Label: Status
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: video
  • Label: Video
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: url_type
  • Label: Url Type
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: popup_size
  • Label: Popup Size
  • Read Only: No
  • Required: No

 

  • Name: jpg
  • Label: JPEG
  • Read Only: No
  • Required: No

 

  • Name: preview
  • Label: Preview
  • Read Only: No
  • Required: No

 

  • Name: description
  • Label: Description
  • Read Only: No
  • Required: No

 

  • Name: website
  • Label: Website
  • Read Only: No
  • Required: No

 

  • Name: autostart
  • Label: Autostart
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: auto_gen
  • Label: Auto Gen
  • Read Only: No
  • Required: Yes
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: close_on_flip
  • Label: Close On Flip
  • Read Only: No
  • Required: No
  • Default Value: false
  • Options:
  • false => No
  • true => Yes

 

  • Name: target
  • Label: Target
  • Read Only: No
  • Required: No

 

  • Name: alpha
  • Label: Alpha
  • Read Only: No
  • Required: Yes
  • Default Value: 100

3.7 Virtual Page

3.7.1 Special Fields

The width_x, height_y, and pdf_* fields are special. They will set the start_* and end_* fields by means of calculations. Because of this, some rules have to be followed to use them:

Set the page_id first. The page must have already finished conversion.

Set the corresponding *start_* before using width or height.

Validation errors will happen to the start_* and end_* fields, not the special fields.

3.7.2 Fields

  • Name: issue_id
  • Label: Issue Id
  • Read Only: No
  • Required: Yes

 

  • Name: page_id
  • Label: Page Id
  • Read Only: No
  • Required: Yes

 

  • Name: page_name
  • Label: Page Name
  • Read Only: No
  • Required: No

 

  • Name: internal_page_number
  • Label: Internal Page Number
  • Read Only: No
  • Required: No

 

  • Name: type
  • Label: Type
  • Read Only: No
  • Required: Yes
  • Default Value: 1

 

  • Name: type_sequence
  • Label: Type Sequence
  • Read Only: No
  • Required: Yes
  • Default Value: 1

 

  • Name: audio_end_ipn
  • Label: Audio End Ipn
  • Read Only: No
  • Required: No
  • Default Value: 0

 

  • Name: rate
  • Label: Rate
  • Read Only: No
  • Required: No
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

3.8 Article

3.8.1 Fields

  • Name: id
  • Label: Id
  • Read Only: Yes
  • Required: No
  • Type: Hidden
  • Validation:
  • type => numeric

 

  • Name: page_id
  • Label: Page
  • Read Only: No
  • Required: Yes
  • Type: Select
  • Validation:
  • type => numeric


  • Name: title
  • Label: Title
  • Read Only: No
  • Required: Yes
  • Type: text
  • Validation:
  • maxLength => 255


  • Name: body
  • Label: Article
  • Read Only: No
  • Required: No
  • Type: Textarea
  • Validation:
  • Default Value:


  • Name: markdown
  • Label: Markdown
  • Read Only: No
  • Required: No
  • Type: Textarea
  • Validation:
  • Default Value:


  • Name: has_markdown
  • Label: Has Markdown
  • Read Only: No
  • Required: No
  • Type: Checkbox
  • Validation:
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes


  • Name: author
  • Label: Author
  • Read Only: No
  • Required: No
  • Type: text
  • Validation:
  • maxLength => 2048
  • Default Value:


  • Name: article_container_id
  • Label: Container
  • Read Only: No
  • Required: No
  • Type: Select
  • Validation:
  • type => numeric
  • Default Value:


3.9 Article Container

3.9.1 Fields

  • Name: id
  • Label: ID
  • Read Only: Yes
  • Required: No
  • Type: text
  • Validation:
  • type => numeric


  • Name: name
  • Label: Name
  • Read Only: No
  • Required: Yes
  • Type: text
  • Validation:
  • maxLength => 255


  • Name: order_index
  • Label: Order
  • Read Only: No
  • Required: No
  • Type: text
  • Validation:
  • type => numeric


  • Name: issue_id
  • Label: Issue
  • Read Only: No
  • Required: Yes
  • Type: text
  • Validation:
  • type => numeric


3.10 Tab

3.10.1 Fields

  • Name: id
  • Label: Id
  • Read Only: Yes
  • Required: No

 

  • Name: issue_id
  • Label: Issue Id
  • Read Only: No
  • Required: Yes

 

  • Name: title
  • Label: Title
  • Read Only: No
  • Required: Yes

 

  • Name: page_id
  • Label: Page Id
  • Read Only: No
  • Required: Yes

 

  • Name: color_1
  • Label: Color 1
  • Read Only: No
  • Required: Yes

 

  • Name: color_2
  • Label: Color 2
  • Read Only: No
  • Required: Yes

 

  • Name: color_text
  • Label: Text Color
  • Read Only: No
  • Required: Yes

 

  • Name: shadow_text
  • Label: Text Shadow Color
  • Read Only: No
  • Required: Yes

 

  • Name: order_index
  • Label: Order Index
  • Read Only: No
  • Required: Yes

 

  • Name: description
  • Label: Description
  • Read Only: No
  • Required: No

 

  • Name: internal_page_number
  • Label: Internal Page Number
  • Read Only: No
  • Required: Yes

3.11 Page operations

3.11.1 Unsupported Actions

PUT

DELETE

3.11.2 Retrieving the status of existing operations

GET /AddReplacePages/(Issue Id)/[Job Id]

  • Retrieves the details of existing jobs
  • Ex:[{"id":25,"status":"Queued","conversionPercentage":0,"details":null}]
  • - 'details' is a string that can contain details about the conversion(errors, notices, etc)
  • Ex: "details":"Error. File not found!”
  • - 'conversionPercentage' is the process completion (0-100)
  • - 'status' can be '0' - Queued, '1' - Processing, '2' - Finished or '3'  Error

POST /AddReplacePages/(Issue Id)

3.11.3 Adding Pages

Page addition has the following requirements:

  • One or more files. Any field name can be used.
  • Page types 6 and 7 require a single JPEG file. The rest require one or more PDF files that contain one or more pages.
  • operation = add
  • pageNumber
  • Page types 10, 12 or 13 use this to determine the page on which the added pages will be attached.
  • The rest of page types use it as the page number from which the pages will be added. All existing pages that have an page number equal or larger than this number will be shifted to the right to accommodate any number of pages that will be added.
  • subSequence if pageType is 10, 12 or 13. This behaves like pageNumber.
  • For pageType 10 the maximum is 8, for pageType 12 the maximum number is 4. The number of pages that can be added decreases as subSequence increases (max - subSequence + 1 = n). So for subSequence=8 only one page can be added (on the last position). This can be used to fill missing pages if you already have 7 pages of that type added.
  • pageType

All other fields are optional.

Returns an object that contains the job id(if successful) and other details/messages, or an error.

Ex:{"id":31,"success":{"message":"Pages uploaded successfully.

Operation is queued."}}

Ex: {"error":{"message":"Page validation failed","validationErrors":

["The file type is not compatible with the other settings"]}}

3.11.4 Replacing Pages

  • One or more files.
  • The same requirements as 'add'
  • operation = replace
  • pageNumber
  • The same requirements as 'add'
  • subSequence
  • The same requirements as 'add'
  • pageType

All other fields are optional.

3.11.5 Replacing SWF files only

  • One SWF file.
  • operation = replaceSWF
  • pageNumber
  • The page number for which to replace the SWF
  • pageType
  • Cannot be 6 or 7

All other fields are optional.

 3.11.6 Replacing Backgrounds only

  • One PDF file with one page.
  • operation = replaceBackground
  • pageNumber
  • The page number for which to replace the background. The SWF and thumbs will be kept.
  • pageType
  • The same requirements as 'replaceSWF'

All other fields are optional.

3.11.7 Fields

If you specify a callbackURL, the data that will be posted has the following format:

{"id":"56","issueId":"1234","details":"Success or error message(s) here","status":0 for error, 1 for success}

pageName can be anything. If it is in the 'word number' format(ie: Page 1) the number will automatically be replaced with a counter starting from 1 and incrementing for every page added.

  • Name: operation
  • Required: Yes
  • Type: Select
  • Options:
  • add => Add
  • replace => Replace
  • replaceSWF => Replace SWF
  • replaceBackground => Replace Animation Background

 

  • Name: pageNumber
  • Required: Yes
  • type => numeric

 

  • Name: subSequence
  • Required: No
  • type => numeric
  • Default Value: 1

 

  • Name: pageType
  • Required: Yes
  • Type: Select
  • type => numeric
  • Default Value: 1
  • Options:
  • 1 => Normal Page
  • 2 => Small Page
  • 3 => Belly Band
  • 4 => Blow In
  • 5 => Dutch Door
  • 6 => iPhone Interstitial
  • 7 => iPad Interstitial
  • 8 => Android Interstitial
  • 9 => Slideout
  • 10 => Gatefold
  • 12 => Barndoors
  • 13 => Tall Page

 

  • Name: pageDimensions
  • Required: No
  • Type: Select
  • type => numeric
  • Default Value: 0
  • Options:
  • 0 => Preserve original dimensions (Default)
  • 1 => Fit to full
  • 2 => Fit to height but preserve aspect width
  • 3 => Fit to width but preserve aspect height
  • 4 => Fit to 1/2 width and full height

 

  • Name: verticalPosition
  • Required: No
  • Type: Select
  • Options:
  • top => top
  • middle => middle
  • bottom => bottom

 

  • Name: horizontalPosition
  • Required: No
  • Type: Select
  • Options:
  • left => left
  • center => center
  • right => right

 

  • Name: conversionType
  • Required: No
  • Type: Select
  • type => numeric
  • Default Value: 3
  • Options:
  • 1 => Vector
  • 2 => Raster
  • 3 => Forced Full Vector (Default)

 

  • Name: vectorLineStroke
  • Required: No
  • Type: Select
  • type => numeric
  • Default Value: 1
  • Options:
  • 1 => Thin (Default)
  • 2 => Thicker

 

  • Name: simplifyStructure
  • Required: No
  • Type: Checkbox
  • Default Value: 0
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: processLinks
  • Required: No
  • Type: Checkbox
  • Default Value: 1
  • Options:
  • 0 => No
  • 1 => Yes

 

  • Name: pageName
  • Required: No
  • Type: text
  • maxLength => 255

 

  • Name: advertiserId
  • Required: No
  • type => numeric

 

  • Name: callbackURL
  • Required: No
  • Type: text
  • maxLength => 2048

 

  • Name: notifyEmail
  • Required: No
  • Type: text
  • maxLength => 255

3.12 VAR

3.12.1 Fields

  • Name: id
  • Label: Id
  • Read Only: Yes
  • Required: No
  • Type: text
  • Validation:
  • type => numeric

 

  • Name: name
  • Label: Name
  • Read Only: Yes
  • Required: Yes
  • Type: text
  • Validation:
  • maxLength => 100

3.13 Rollover/Offer

3.13.1 Fields

  • Name: id
  • Label: Id
  • Read Only: Yes
  • Required: No
  • Type: text
  • Validation: 
  • type => numeric


  • Name: link_id
  • Label: Link Id
  • Read Only: After Creation
  • Required: No
  • Type: text
  • Validation: 
  • type => numeric


  • Name: publication_id
  • Label: Publication
  • Read Only: After Creation
  • Required: No
  • Type: text
  • Validation: 
  • type => numeric


  • Name: issue_id
  • Label: Issue
  • Read Only: After Creation
  • Required: No
  • Type: text
  • Validation: 
  • type => numeric


  • Name: page_id
  • Label: Page
  • Read Only: After Creation
  • Required: No
  • Type: text
  • Validation: 
  • type => numeric


  • Name: start_x
  • Label: Start X
  • Read Only: No
  • Required: Yes
  • Type: text
  • Validation: 
  • type => decimal


  • Name: start_y
  • Label: Start Y
  • Read Only: No
  • Required: Yes
  • Type: text
  • Validation: 
  • type => decimal


  • Name: end_x
  • Label: End X
  • Read Only: No
  • Required: Yes
  • Type: text
  • Validation: 
  • type => decimal


  • Name: end_y
  • Label: End Y
  • Read Only: No
  • Required: Yes
  • Type: text
  • Validation: 
  • type => decimal


  • Name: title
  • Label: Title
  • Read Only: No
  • Required: Yes
  • Type: Text
  • Validation: 
  • type => alphanumeric
  • allowWhitespace => 1
  • maxLength => 255


  • Name: description
  • Label: Description
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: description_long
  • Label: Description Long
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: filename
  • Label: Filename
  • Read Only: No
  • Required: Yes
  • Type: text
  • Validation: 
  • type => imageSelect
  • maxLength => 255
  • file => Array


  • Name: url
  • Label: Url
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 
  • maxLength => 255


  • Name: price
  • Label: Price
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 
  • maxLength => 255


  • Name: purchase_url
  • Label: Purchase Url
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 
  • maxLength => 255


  • Name: mobileLinkText
  • Label: Mobilelinktext
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 
  • maxLength => 50


  • Name: titleColor
  • Label: Titlecolor
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: descriptionColor
  • Label: Descriptioncolor
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: outlineColor
  • Label: Outlinecolor
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: boxfillColor
  • Label: Boxfillcolor
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: linksColor
  • Label: Linkscolor
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: priceColor
  • Label: Pricecolor
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: footerColor
  • Label: Footercolor
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 


  • Name: sticky
  • Label: Sticky
  • Read Only: No
  • Required: No
  • Type: Checkbox
  • Validation: 
  • Default Value: 0
  • Options: 
  • 0 => No
  • 1 => Yes


  • Name: featured
  • Label: Featured
  • Read Only: No
  • Required: No
  • Type: Checkbox
  • Validation: 
  • Default Value: 0
  • Options: 
  • 0 => No
  • 1 => Yes


  • Name: category_name
  • Label: Category Name
  • Read Only: No
  • Required: No
  • Type: Text
  • Validation: 


  • Name: brand_name
  • Label: Brand Name
  • Read Only: No
  • Required: No
  • Type: Text
  • Validation: 


  • Name: image_url
  • Label: Image URL
  • Read Only: No
  • Required: No
  • Type: Text
  • Validation: 


  • Name: footer_text
  • Label: Footer Text
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 
  • Default Value: 


  • Name: footer_url
  • Label: Footer Url
  • Read Only: No
  • Required: No
  • Type: text
  • Validation: 
  • type => url
  • maxLength => 2048
  • Default Value:

3.14 SKU (Rollover child)

3.14.1 Labels

  • Name: id
  • Label: Id
  • Read Only: true 
  • Validation: 
  • Type: numeric


  • Name: old_id
  • Label: Old Id
  • Read Only: true
  • Validation: 
  • Type: numeric


  • Name: sku
  • Label: Sku
  • Read Only: true
  • Validation: 
  • maxLength => 255


  • Name: name
  • Label: Name
  • Read Only: true
  • Required: true
  • Validation: 
  • maxLength => 255


  • Name: description
  • Label: Description
  • Read Only: true


  • Name: unit_type
  • Label: Unit Type
  • Read Only: true


  • Name: price
  • Label: Price
  • Read Only: true


  • Name: page_id
  • Label: Page Id
  • Read Only: true
  • Required: true
  • Validation: 
  • Type: numeric


  • Name: brand_id
  • Label: Brand Id
  • Read Only: true
  • Validation: 
  • Type: numeric


  • Name: sku_category_id
  • Label: Sku Category Id
  • Read Only: true
  • Validation: 
  • Type: numeric


  • Name: local_path
  • Label: Local Path
  • Read Only: true
  • Validation: 
  • maxLength => 255


  • Name: filename
  • Label: Filename
  • Read Only: true
  • Validation: 
  • maxLength => 255


  • Name: url
  • Label: Url
  • Read Only: true
  • Validation: 
  • maxLength => 255


  • Name: currency
  • Label: Currency
  • Required: true
  • Read Only: true
  • Validation: 
  • maxLength => 10


  • Name: price_desc
  • Label: Price Desc
  • Read Only: true
  • Validation: 
  • maxLength => 255