Developer API – Stores, Carts, and Websites

StoreData

This call allows you to specify one or more stores which act as the source of product data to be synchronized with the ChannelUnity account.

Input

<ChannelUnity>
 <MerchantName>merc</MerchantName>
 <Authorization>ZWd....DI=</Authorization>
 <ApiKey>123123</ApiKey>
 <RequestType>StoreData</RequestType>
 <Payload>
    <StoreList>
       <Store>
          <FriendlyName>My Store</FriendlyName>
          <URL>http://xxxx</URL>
          <MainCountry>UK</MainCountry>
          <FrameworkType>Custom</FrameworkType>
          <WebsiteId>1</WebsiteId>
          <StoreId>1</StoreId>
          <StoreviewId>1</StoreviewId>
       </Store>
       <!-- <Store> element repeated for each store -->
    </StoreList>
 </Payload>
</ChannelUnity>

The FriendlyName is a human-readable name for the store, and is shown in the ChannelUnity interface under Setup -> Online Stores. The URL identifies the location of the store, and is important to be correct if you wish to use the callbacks in this API. The MainCountry is a two letter country code to identify the store location (not currently used). The FrameworkType identifies common shopping cart types, when recognised, this shows an appropriate icon in the ChannelUnity interface. The WebsiteId, StoreId, and StoreviewId are optional, and were designed primarily for Magento support. These can be used to hold any values which are then passed back to the URL given when callbacks take place. WebsiteId, StoreId, and StoreviewId each must contain an integer value of 1 or greater.

Output

<ChannelUnity>
 <CreatedStoreId>1</CreatedStoreId>
 
 <!-- <CreatedStoreId> element repeated for each store -->
 
 <Status>OK</Status>
</ChannelUnity>

 

The response of the StoreData call is a list of Store ID numbers which uniquely identify each store. When a store is attempted to be created with a URL which already exists, no further stores are created, and the existing store is updated.

StoreDelete

This removes a store previously added by the StoreData API.

Provide the exact URL that you provided to StoreData, along with the corresponding StoreId, StoreViewId, and WebsiteId.

An OK response confirms the store is deleted. Products and categories associated with the store are deleted also.

Input

<ChannelUnity>
 <MerchantName>DemoAccount</MerchantName>
 <Authorization>RGVtbjE4NWM=</Authorization>
 <ApiKey>18eb22321444ab</ApiKey>
 <RequestType>StoreDelete</RequestType>
 <SourceURL><![CDATA[http://]]></SourceURL>
 <Payload>
    <StoreDelete>
       <StoreId>2</StoreId>
       <DeletedStoreViewId>2</DeletedStoreViewId>
       <WebsiteId>2</WebsiteId>
    </StoreDelete>
 </Payload>
</ChannelUnity>

Output

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

 

If you want to sell on marketplaces but don't yet have an online store, Synchromatic is the solution for you.
More Details