Developer API – Listing management

AcceptListingFee

For eBay marketplaces only, accepts any pending listing fees.

Only requirement is the subscription ID of the eBay channel.

Input

1
2
3
4
5
6
7
8
9

<ChannelUnity>
<MerchantName>merch</MerchantName>
<Authorization>TWF0dFR...==</Authorization>
<ApiKey>123123123</ApiKey>
<RequestType>AcceptListingFee</RequestType>
<Payload>
<SubscriptionID>65</SubscriptionID>
</Payload>
</ChannelUnity>

Output

1
2
3
4

GetChannelSettings

GetChannelSettings returns all of the settings that relate to a particular channel (subscription ID). Note that these settings are the top-level settings that relate to a channel/marketplace subscription (Amazon, or eBay etc). These are not the same as listing settings which are settings which are applied on a per-product basis. The channel settings are things like, whether product upload, image upload etc. are enabled, and the channel name.

Input

1
2
3
4
5
6
7
8
9

<ChannelUnity>
<MerchantName>merch</MerchantName>
<Authorization>TWF0dFR...==</Authorization>
<ApiKey>123123123</ApiKey>
<RequestType>GetChannelSettings</RequestType>
<Payload>
<SubscriptionID>57</SubscriptionID>
</Payload>
</ChannelUnity>

Output

Note: Passwords are not returned in the output for security reasons. The data returned varies based on the type of marketplace being queried.

1
2
3
4
5
6
7
8
9
10
11
12

GetListingSettings

Returns information about all available listing settings, or optionally about one specific listing setting based on the given listing setting ID.

To retrieve the listing settings in pages, inside the <Payload></Payload> tags you can specify <Limit></Limit> and <Offset></Offset> tags.

These must contain positive integers. Offset is ignored if Limit is not set.

Input

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<ChannelUnity>
<MerchantName>merch</MerchantName>
<Authorization>TWF0dFR...==</Authorization>
<ApiKey>123123123</ApiKey>
<RequestType>GetListingSettings</RequestType>
<SourceURL><![CDATA[http://]]></SourceURL>
<Payload>

[ Optional elements start ]
<ListingSettingID>301071</ListingSettingID>
[ Optional elements end ]

</Payload>
</ChannelUnity>

Output

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

<ListingSettings>
<ListingSetting>
<SettingId>1521772</SettingId>
<Code><![CDATA[settingtemplate]]></Code>
<Sku><![CDATA[CU_AMZ_IT]]></Sku>
<Id>1521772</Id>
<Title><![CDATA[AMZ IT reduced]]></Title>
<PricePercentage>-15</PricePercentage>
<PriceAmountInflation><![CDATA[]]></PriceAmountInflation>
<EnableRepricing>1</EnableRepricing>
<MinFeedbackScore><![CDATA[]]></MinFeedbackScore>
[ More settings follow … ]

</ListingSetting>
</ListingSettings>

GetListingThemes

Returns all listing themes in the ChannelUnity account, or returns one listing theme based on the given (optional) ID number.

Listing themes are used for some marketplaces (mainly eBay), for styling listings.

Input

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<ChannelUnity>
<MerchantName>DemoAccount</MerchantName>
<Authorization>RGVtb0YjE4NWM=</Authorization>
<ApiKey>18eg45h348ab</ApiKey>
<RequestType>GetListingThemes</RequestType>
<SourceURL><![CDATA[http://]]></SourceURL>
<Payload>

[ Optional elements start ]
<ListingThemeID>2</ListingThemeID>
[ Optional elements end ]

</Payload>
</ChannelUnity>

Output

1
2
3
4
5
6
7
8
9
10
11
12

<ChannelUnity>
<ListingThemes>
<ListingTheme>
<Id>2</Id>
<Name><![CDATA[My theme]]></Name>
<Template><![CDATA[ <html><head><title></title> ..... lobortis nisl ut aliquip ex ea commodo consequat.}</span> </div>
</body></html>
]]></Template>
<Updated><![CDATA[2015-05-15 16:01:37]]></Updated>
</ListingTheme>
</ListingThemes>
</ChannelUnity>

GetProductsSelectedToList

Returns information about products that are selected to be listed on a given marketplace channel.

Specify the subscription ID, an offset, and a count. The latter two parameters allow you to page through the results.

The offset must be zero or greater. The count must be between 1 and 1000.

Input

1
2
3
4
5
6
7
8
9
10
11
12

<ChannelUnity>
<MerchantName>DemoAccount</MerchantName>
<Authorization>RGVtbM=</Authorization>
<ApiKey>18ebdfh4363448ab</ApiKey>
<RequestType>GetProductsSelectedToList</RequestType>
<SourceURL><![CDATA[http://]]></SourceURL>
<Payload>
<SubscriptionID>53503</SubscriptionID>
<Offset>0</Offset>
<Count>100</Count>
</Payload>
</ChannelUnity>

Output

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

<ChannelUnity>
<Products>
<Product>
<product_id>1443</product_id>
<remote_product_id>697851</remote_product_id>
<product_type></product_type>
<select_to_list>0</select_to_list>
<repricing_enabled>0</repricing_enabled>
<sku>955634</sku>
<title><![CDATA[ Aluminium Leather Case for Apple iPhone ]]></title>
<description><![CDATA[ <p>This <strong>iPhone 4 Leather Case</strong> with aluminium lining is crafted from the finest quality leather.</p> ]]></description>
<category>33138945</category>
<qty>10</qty>
<price>100.00</price>
<create_time><![CDATA[ 2015-05-14 16:32:39 ]]></create_time>
<update_time><![CDATA[ 2015-05-14 21:41:50 ]]></update_time>
<image><![CDATA[ https://cdn.shopify.com/s/files/1/0848/3556.jpeg?v=4567891 ]]></image>
<url><![CDATA[ http://00000.myshopify.com&accesstoken= ]]></url>
<z_created_at><![CDATA[ 2015-05-14T16:33:02+01:00 ]]></z_created_at>
<z_updated_at><![CDATA[ 2015-05-14T16:33:02+01:00 ]]></z_updated_at>
<z_option_Size></z_option_Size>
[... more fields depending on what is provided in the online store ...]

</Product>
[... Product element repeats ...]
</Products>

<Status>OK</Status>
</ChannelUnity>

GetProductSubscriptionAssignment

Returns the current listing setting and listing theme set against all the products for a given marketplace channel.

If you wish to know the current feed status of the products on that channel, provide the tag <IncludeFeedStatus>true</IncludeFeedStatus> in the call.

Each product will then have an extra tag in the Output of <FeedStatus>

This will tell you if a product is in NotListed, Uploading, Listed, or FixRequired status.

Input

1
2
3
4
5
6
7
8
9
10
11
12
13

<ChannelUnity>
<MerchantName>merch</MerchantName>
<Authorization>TWF0dFR...==</Authorization>
<ApiKey>123123123</ApiKey>
<RequestType>GetProductSubscriptionAssignment</RequestType>
<SourceURL><![CDATA[http://]]></SourceURL>
<Payload>
<SubscriptionID>65</SubscriptionID>
[optional]
<IncludeFeedStatus>true</IncludeFeedStatus>
[end optional]
</Payload>
</ChannelUnity>

Output

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

<ProductSubscriptionAssignment>
<Product>
<ProductId>121</ProductId>
<Sku>D321</Sku>
<SelectToList>1</SelectToList>
<IsPaused>0</IsPaused>
<ListingSettingId>2351</ListingSettingId>
<ListingThemeId>1</ListingThemeId>
<UpdateTime><![CDATA[2019-01-22 10:13:34]]></UpdateTime>
[optional]
<FeedStatus>Listed</FeedStatus>
[end optional]
</Product>
<Product>
<ProductId>34</ProductId>
<Sku>H2256</Sku>
<SelectToList>1</SelectToList>
<IsPaused>0</IsPaused>
<ListingSettingId>346223</ListingSettingId>
<ListingThemeId>2</ListingThemeId>
<UpdateTime><![CDATA[2019-01-22 10:13:34]]></UpdateTime>
[optional]
<FeedStatus>FixRequired</FeedStatus>
[end optional]
</Product>

[ <Product> element repeated as required ]

</ProductSubscriptionAssignment>

GetRepriceData

Returns information on how the current marketplace price was calculated, taking into account the price field mapped, the listing setting inflation applied, and if it is an Amazon channel then the repricing against competitors.

You can filter by marketplace (SubscriptionID), or SKU.

Filtering by SubscriptionID will give data for the first 1000 products by default, but you can also give a Limit and Offset to refine this.

Filtering by SKU will give data for that SKU for every marketplace it is listed on.

Input

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<ChannelUnity>
<MerchantName>merch</MerchantName>
<Authorization>TWF0dFR...==</Authorization>
<ApiKey>123123123</ApiKey>
<RequestType>GetRepriceData</RequestType>
<SourceURL><![CDATA[http://]]></SourceURL>
<Payload>
<SKU>1394797125</SKU>
[ Optional elements start ]
<Limit>10</Limit>
<Offset>0</Offset>
[ Optional elements end ]

</Payload>
</ChannelUnity>

Output

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

<?xml version="1.0"?>
<ChannelUnity>
<RepriceResult>
<SKU>1394797125</SKU>
<SubscriptionId>1990528</SubscriptionId>
<RepriceData>No value for mapped price, using default of 0.99
Standard price is 0.99 GBP
No percentage is added to the price
No value is added to the price
Repricing is not in effect
</RepriceData>
</RepriceResult>
<RepriceResult>
<SKU>1394797125</SKU>
<SubscriptionId>2095830</SubscriptionId>
<RepriceData>Standard price is 0.99 GBP
No percentage is added to the price
No value is added to the price
</RepriceData>
</RepriceResult>
<Status>OK</Status>
</ChannelUnity>

SelectToList

Enables one or more products to be listed on a given marketplace channel, or cancels the listing of one or more products on a given marketplace channel. You may send a list of SKUs within the EnableListing element, or alternatively a list of SKUs within the CancelListing element, or both.

If you enable listing on a SKU already enabled, it will cause the product to be reuploaded to the corresponding marketplace.

Input

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

<ChannelUnity>
<MerchantName>merch</MerchantName>
<Authorization>TWF0dFR...==</Authorization>
<ApiKey>123123123</ApiKey>
<RequestType>SelectToList</RequestType>
<SourceURL><![CDATA[http://]]></SourceURL>
<Payload>
<SubscriptionID>65</SubscriptionID>

<EnableListing>
<SKU>HJ907</SKU>
[ <SKU> element repeated as required ]
</EnableListing>

<CancelListing>
<SKU>866JONF</SKU>
[ <SKU> element repeated as required ]
</CancelListing>
</Payload>
</ChannelUnity>

Output

1
2
3
4
5
6

SetProductSubscriptionAssignment

Allows you to set the listing setting or listing theme against a particular product for a particular marketplace channel. You will need to know the ID number that represents the marketplace you wish to affect (can be obtained using the ValidateUser API call’s SettingsLinkId element). You’ll need the SKU code of the product(s) you wish to change, along with the listing setting ID and/or the listing theme ID. To obtain listing setting and theme ID numbers, you may use the GetListingSettings and GetListingThemes APIs.

To change multiple skus they each need to be in their own <SKU></SKU> tags.

Input

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<ChannelUnity>
<MerchantName>merch</MerchantName>
<Authorization>TWF0dFR...==</Authorization>
<ApiKey>123123123</ApiKey>
<RequestType>SetProductSubscriptionAssignment</RequestType>
<SourceURL><![CDATA[http://]]></SourceURL>
<Payload>
<SubscriptionID>65</SubscriptionID>
<SKU>C445</SKU>
<SKU>D114</SKU>
<ListingSettingID>138660</ListingSettingID>
<ListingThemeID>2</ListingThemeID>
</Payload>
</ChannelUnity>

Output

1
2
3