eBay provides its sellers with an option to use HTML templates for listing items, where sellers could provide a rich HTML content template (on an item level) and fully control the appearance of the listing on the eBay front end. This feature helps sellers to enhance the way their product looks on eBay and to be consistent in terms of branding. Most sellers create 1 or more HTML templates for listing their items on eBay. The emphasis of this feature is on enabling you to use the same HTML template for multiple product listings, yet display information that is specific to a product in your eBay store.
Usually, these HTML templates have place-holders or tokens to hold the listing specific information. This feature allows the seller to dynamically replace these placeholders or tokens with product attributes/information from NetSuite before the listing is created/updated on eBay.
Note: Celigo doesn’t provide an HTML template. This feature only allows you to use an HTML template for importing item information from NetSuite to eBay.
Things to Remember
- The Integration App supports rendering images in the HTML Template from a custom record in NetSuite when the custom label you wish to use has “__IMAGE” as a prefix. Images will not be rendered when this prefix is not used in the custom label. This field is case sensitive, so the prefix “__IMAGE” must always be added in upper case.
- CustLabel__IMAGE and __imageCustLabel are incorrect ways of defining the custom label. The correct way to define this custom label is __IMAGECustLabel.
- If you do not provide the Custom Label for every NetSuite field specified in the saved search, the field id of the NetSuite field has to be used for replacing placeholder or tokens in the HTML template.
Implement eBay HTML Template for NetSuite Item
Assumption: It is assumed that before performing this procedure you have already created an HTML template.
To implement eBay HTML template:
- In NetSuite, configure Celigo eBay Item HTML Template Export saved search.
- Configure the HTML Template.
- Add and apply the HTML template for the desired NetSuite Item.
- In NetSuite, configure Celigo eBay Item Export Search saved search in NetSuite.
- Deploy the HTML script.
Configure Celigo eBay Item HTML Template Export Saved Search
You can use the following steps to edit an existing item based saved search (Celigo eBay Item HTML Template Export) and create a new item based saved search that holds values that the HTML template requires.
- In NetSuite global search box, search for “Celigo eBay Item Html Template Export Search”.
- From the search results, select Celigo eBay Item Html Template Export Search. The saved search page is displayed.
Note: You can use the Celigo eBay Item HTML Template Export Search [locked] saved search as a template to create your own saved search. This saved search when edited is to be saved with another name. Or, you can use your existing saved search that holds values that the HTML template requires.
- Click Edit this Search.
- Change the Search Title value to provide a new name to the item saved search that you wish to use for supporting HTML templates. In the following image, the search title has been updated as eBay HTML and NetSuite Item Export Search:
- Click the Results sub-tab and add all the NetSuite fields from where you wish to pick the item data and assign an appropriate custom label wherever applicable as shown in the following image:
Notes:
- The Integration App supports rendering images in the HTML Template from a custom record in NetSuite when the custom label you wish to use has “__IMAGE” as a prefix. Images will not be rendered when this prefix is not used in the custom label. This field is case sensitive, so the prefix “__IMAGE” must always be added in the upper case.
- CustLabel__IMAGE and __imageCustLabel are incorrect ways of defining the custom label. The correct way to define this custom label is __IMAGECustLabel.
- If you do not provide the Custom Label for every NetSuite field specified in the saved search, the field id of the NetSuite field has to be used for replacing placeholder or tokens in the HTML template.
- Once you have finished adding all the fields from where the HTML template should pick the item information, click the Save drop-down icon and select Save As. The new saved search is created.
Configure HTML Template
You must configure the HTML template to match the modifications you made in Configure Celigo eBay Item HTML Template Export and Configure Celigo eBay Item Export Search. The custom labels/field IDs that you have introduced in these saved searches should match with your HTML template. For example, the following HTML template code snippet illustrates the custom labels shown in the below image. Here, SKU, Integration App Tile, Description, Price, Category ID, UPC, and Brand custom labels are matched in the HTML template.
<div id="sku">{{SKU}}</div> // Note: if you have not specified any CUSTOM LABEL in NetSuite, you can specify the Field ID of that field.
<div id="title">{{Title}}</div>
<div id="description">{{Description}}</div>
<div id="price">{{Price}}</div>
<div id="categoryid">{{CategoryID}}</div>
<div id="upc">{{UPC}}</div>
<div id="brand">{{Brand}}</div>
// The following code-snippet illustrates how to map image custom fields to HTML template
<div id"sampleimage">{{__IMAGEsampleimage}}</div> // where __IMAGE is the mandatory prefix for image fields and sampleimage is any name given to the image field.
The HTML templates normally contain placeholders {{placeholder}} or tokens to hold the listing specific information. This enables your HTML template to pick the values from the NetSuite fields.
Notes:
- When you replace the placeholders or tokens that hold the listing specific information with the aforementioned options, you must ensure that the replaced text does not contain any spaces or special characters (Like (), @, “”, ;, and so on).
- Once the template is altered to pick values from the NetSuite field, the template will remain static but values will change for every item where this template is selected in the NetSuite item record.
- For a matrix item, only the information and images available in the parent item details are displayed on eBay. Child items information is ignored.
- For matrix items, you are required to save the parent item twice to reflect the new changes in the field values in the template.
Add and Apply HTML Template to NetSuite Item
To create an HTML template for a NetSuite item:
- In NetSuite, go to Lists > Accounting > Items.
- Click Edit on the desired item; then go to the eTail subtab.
- Go to the EBAY HTML TEMPLATE LISTING field and click +.
- Click the + icon beside the HTML TEMPLATE field and select the desired HTML template. In addition, enter or select appropriate details in NAME, TEST SAVED SEARCH, RENDERED HTML TEMPLATE ITEM FIELD, and then click Save.
Note: The RENDERED HTML TEMPLATE ITEM FIELD allows you to enter the internal ID of the custom field you wish to use for storing the rendered data from the HTML template. If you do not provide any value in RENDERED HTML TEMPLATE ITEM FIELD, the Integration App will render the data in EBAY RENDERED HTML TEMPLATE that comes with the bundle.
- Under the eTail tab, go to the EBAY HTML TEMPLATE LISTING field and select the desired template and click Save.
- The modified item is processed for the HTML template selected and the result is displayed under the EBAY RENDERED HTML TEMPLATE field if you do not specify any custom field in step 4.
Note: Any errors related to the HTML template that occurs during flow execution are displayed in EBAY HTML TEMPLATE PROCESSING ERRORS.
Configure Celigo eBay Item Export Search Saved Search in NetSuite
Perform the below-mentioned steps to modify the Celigo eBay Item Export Search saved search. This will enable the Integration App to pick the description that has been rendered using the HTML template applied in the Item record. Use the following steps to make these changes in the item record:
- In NetSuite global search box, search for “Celigo eBay Item Export Search”.
- From the search results, select Celigo eBay Item Export Search. The saved search page is displayed.
Note: You can use the Celigo eBay Item Export Search [locked] saved search as a template to create your own saved search. This saved search when edited is to be saved with another name. Or, you can use your existing saved search that fetches the description rendered using the HTML script. - Click Edit this Search.
- Click the Results sub-tab and change the highlighted value of description with the field you wish to use for the description.
- Click Description and replace it with EBAY RENDERED HTML TEMPLATE as shown in the image below.
Notes:
- In this step, we are using the default description field added by the Integration App which is EBAY RENDERED HTML TEMPLATE.
- Similar to the EBAY RENDERED HTML TEMPLATE field, you can use any other NetSuite rich text field to send the item information rendered from the HTML template applied on that item.
Deploy HTML script
Perform the below-mentioned steps to deploy the HTML script.
- Click Customization> Scripting> Scripts. The Script page is displayed.
- From the list of scripts find the Celigo eBay item Html Template script and click Deployments. The Script Deployments page is displayed.
- Click the Show Undeployed checkbox. A new column, DEPLOYED, is displayed.
- For the record typescript, you wish to deploy, select the DEPLOYED checkbox against that Record Type.
Note: If you do not want to use the default ETAIL CHANNEL field available on the item record to define the sales channel for a NetSuite Item, you can enter the Internal Id of the checkbox that you use to set the associated channel for a specific item in the EBAY CRITERIA ITEM FIELD ID field. If any value is not provided in the EBAY CRITERIA ITEM FIELD ID field, the Integration App will use the eTail channel field available in the item record. - Click Submit.
Comments
Sorry if missed this, but then what is the syntax that needs to be entered directly in the HTML to call to these fields after the saved searches are set up? ${fieldID} ?
Hi Tommy, this article has been updated with additional information. Pls check the section "Configure HTML Template".
Please sign in to leave a comment.