This guide assumes knowledge of HTML and CSS and is written for web developers. If you are not familiar with these concepts please refer your web developer to this guide.

We do not recommend merchants edit their own templates.  We do not provide HTML or CSS support. However, we will provide support for tag specific questions.

Index

Prerequisites

Templates are edited via the Shopify template editor. Shopify Lite doesn't support template editing at the time of writing this article, so customising templates is not supported for merchants subscribed to Shopify Lite.

Template architecture explained

How to edit the ImageSmart eBay Listing Template

Previewing the eBay Listing

Preview Button

Preview Panel

Preview Tab / Open in new browser tab

Editing the listing templates

Template File Location

CSS Files

Refreshing the Preview

Previewing Multiple Listings

Click the + button in the toolbar of the Preview Tab to add extra listings to the Preview. This makes it possible to see the effect of template changes on various settings without the need to switch between products or change settings. 

Committing your edits

Template Variables

Variable	Purpose
ProductID	The Unique Codisto Product ID. Not to be confused with the Listing ID or any identifier in Shopify. It is used together with CDNURL to access product images.
Title	The Title of the Listing as set via the eBay Title column in XpressGrid.
EbayDescription	The product description
EbayShippingType	The shipping type selected. Possible values are: Flat Freight Calculated FlatFlat rate shipping as defined via XpressGrid. The rate is in the FlatRateShipping variable. The default template displays Flat with FlatRateShipping of 0 as Free. Freight Uses shipping rates defined in Shopify. The default template shows a freight calculator widget, which calls back to Shopify when a buyer enters their post code in the listing. Calculated Uses eBay's Australia Post calculated rates. The default template refers the buyer to the shipping tab in the listing.
FlatRateShipping	If EbayShippingType is Flat, this variable contains the flat rate shipping amount
ExpressShipping	Whether or not Express Shipping is enabled. The value will be 0 if off or a non 0 number if on. Using an {if ExpressShipping}{/if} condition caters for these possible values.
ExpressShippingCost	The cost for Express Shipping. May contain a value even if ExpressShipping is disabled, so it should only be conditionally displayed.
ReturnsAccepted	Whether or not returns are accepted. The value will be 0 if off or a non 0 number if on. Using an {if ReturnsAccepted}{/if} condition caters for these possible values.
ReturnsWithin	Contains the returns days constant. Can be one of the following values: Days_3 Days_7 Days_14 Days_30 Days_60 May contain a value even if ReturnsAccepted is disabled, so it should be conditionally displayed.
RefundOption	Contains the refund option constant. Can be one of the following values: MoneyBack Exchange MerchandiseCredit
EbayShippingCostPaidByOption	Refers who pays return shipping according to the Seller's return policy for the product. Possible values are: Buyer Seller
EbayReturnPolicyDescription	Contains the return policy HTML for the product
EbayUserID	Contains the Seller's eBay ID
MerchantName	Name of the merchant as registered with Codisto
EbayItemID	Contains the eBay Item ID
MerchantURL	Contains the URL to the Shopify website
MoneyOrderAccepted	Whether or not Money Order is accepted for payment. The value will be 0 if off or a non 0 number if on. Using an {if MoneyOrderAccepted}{/if} condition caters for these possible values.
DirectDepositAccepted	Whether or not Direct Deposit is accepted for payment. The value will be 0 if off or a non 0 number if on. Using an {if DirectDepositAccepted}{/if} condition caters for these possible values.
PickupOption	Whether or not pick up in store is offered. The value will be 0 if off or a non 0 number if on. Using an {if PickupOption}{/if} condition caters for these possible values.
ProductCode	Contains the code of the product
CDNURL	The CDN (Content Delivery Network) URL for the account. All media is served via this URL.
eBaySiteID	The eBay Site ID of the listing. Use this to show content conditionally based on which eBay site the listing is published on. See  eBay Site ID to Global ID Mapping for a list of eBay Site IDs
BundleQuantity	For listings where a purchase is for multiple items such as a case of wine, this contains the quantity the buyer will receive for each one purchased.
eBayPrice	The price from the eBay Price column of the XpressGrid  Note: When rendering this value in the template it should be formatted using the eBayCurrency like:  {format eBayPrice, eBayCurrency} This will ensure the appropriate currency symbol and number of decimal places is displayed.
eBayCurrency	The currency of the listing

Template Frameworks

The template automatically includes the following frameworks, which can be leveraged in your template design:

• Bootstrap v2.3.2 (CSS only)

CSS & JavaScript

Default CSS

Assets contains a file called ebay-styles.css, which contains all the CSS for the eBay templates. It can be modified to suit your requirements. If you are not using the default template, you can replace the existing styles with your own.

Referencing hosted CSS

It is possible but not recommended to reference externally hosted CSS. eBay have strict policies against external links. Even though externally referenced CSS isn't included for the purpose of driving traffic off eBay, the listing is still at risk of being ended for violating the policy.

JavaScript

From June 2017 eBay is blocking Active Content, which rules out the use of JavaScript. Our default template is fully active content compliant and makes no use of JavaScript.

Images

eBay allow up to 12 images per listing. When the template is executed, the data is injected as follows:

The Image URL

Default Product Image

{CDNUrl}/productimages/{ProductID}.png?width=800&etag={etag}

{CDNURL}

All images are hosted on CDN (Content Delivery Network) to ensure fast, reliable serving. The {CDNURL} tag injects the specific URL for the Codisto account.

{ProductID}

The ID of the product

{etag}

To ensure that caching is bypassed if the image changes, the {etag} tag is added to the Query String.

Additional Product Images

Sets

• All of the images are available via the {images} set name.
• Shopify doesn't support tagging of images, so unlike on other platforms, no additional image sets are available
• Shopify doesn't support disabling images on a product, so the set {AllEnabledImages} and {AllImages} sets are the same as the {Images} set. 

Sets support  if and for operations.

{if count(images) > 1}<hr/>{/if}

In the default template, a horizontal line is added if there is more than 1 image.

{for images step=4} <div> ... inner loop ...<br></div> {/for}

The outer for loop iterates over the images 4 at a time, to display 4 per row.

{for Images count=4 start={position}} <div><a href="{cdnurl}{images.src}&width=200&height=200&nostretch"><img src="{cdnurl}{images.src}&width=200&height=200"/></a></div> {/for}

The inner loop iterates over 4 images in the {images} set, starting at {position}, which is the current position in the outer loop.

{images.src}

The {images} set has a src property, which is the preassembled source of additional (non default) images. It contains a reference to the image sequence.

{AllEnabledImages.Tag} {AllImages.Tag}

The AllEnabledImages and AllImages sets have a 'Tag' column which will contain the value of the label (which can also be used as template conditions).

width, height & nostretch Query String parameters

The Codisto CDN automatically resizes images based on the width and height passed in pixels. Pass nostretch if you want to maintain the image aspect ratio within the bounds of the width and height specified.

Referencing additional template media

Place your additional media such as images in the Assets section of your Shopify theme and reference them via your site URL.

Additional template media

Additional template images can be added to the Assets section of the Shopify template. Prefix the filename with ebay- (e.g. ebay-highight.jpg). The ebay- prefix signals to Codisto to synchronise the file. The prefix is dropped. 

Referencing the image is done as follows:

{CDNURL}/ebay/highlight.jpg

Publishing your template

It is important to commit your template (either for adding new templates or changing existing templates). You do this by clicking the white eBay button from with the preview template area. 

New templates will not be available to select in XpressGrid until committed.  Changes to existing templates will not take effect until committed.

It is this way, to allow previewing significant template changes without impacting listings.  This way you have control over when to apply the changes.

If you have blank descriptions, please see "  I have created a new template but my listings have blank descriptions", which goes into more detail of what happens if you don't.

Codisto Attribution

Per our Terms & Conditions, it is a requirement to have the following attribution in the footer of your custom template.

<div class="pull-right logo">
 <span class="muted"> eBay integration</span> by
 <img class="baseline" src="{CDNUrl}/images/codisto-connect.png?width=200&amp;nostretch&amp;v=1" />
</div>