Processing
Partner web stores and product lists

Why be a partner?


The most important is that you can gain advantages over the rest of sellers. Now our partners can upload products from their database into our system therefore, their products will appear among search results for buyers and they can sell their product easier and faster via our system. By regular uploads or downloads of product lists, you can receive discounts (Fee regulation), updated prices can be used to automatic piece price adjustment in your automatic offers and we can continuously start group buys.

How can I be a partner?


First, you need to register yourself. After successful activation of your user profile, there will be a user verification link in successful activation e-mail or on the top of My profile page User account part in Personal menu at the top menu bar. If user verification has successfully finished, go to Web stores and product lists part on My profile page. Inside Web stores and product lists part, you can add a new web store where from you can upload or Bidcage can download your product lists. First, it is suggested to set and save your web store to test mode and test your product list files and if every element is correct, thereafter set it to upload or download mode. You can check out next section for product list formats, their processing and sample files.

Product list formats and processing


We can download or you can upload your product lists from one or more web stores. Currently, only brand new products and their prices are accepted in XML and CSV format through our product processing application programming interface (API). We can only accept the next product list of a web store if 18 hours elapsed after the last product list processing of the store. If a product list of a web store is waiting for processing on our server, we cannot accept another product list from the webstore until it is processed. To download sample files, please click here.

Bidcage downloads your product lists


The full path (URL) and file are also necessary to download your product lists. Product list download is starting at every day 18:00 according to user’s time zone that is saved in user’s own profile. Before we start to download a product list, we check the modification date of the product list file and if it is earlier than or same as the date of last downloaded file we do not download the file (ie. the file is not changed since the last download). If our system does not find the file or any problem arises with the download, it will only try to download the file again in next download period. To download sample files, please click here.

You upload your product lists


Developer PHP files contain helps and comments related to codes. You can freely use codes from all files. Codes have to be modified to your PHP system or framework because those are only sample codes to help faster developing. You can test our processing algorithms if test mode has been selected and saved on My profile page Web stores and product lists part part in Bidcage. To download sample files, please click here.

Content of sample files of product list processing API and their download


Before starting to upload or download product list files, please download and check out API files.
  • Samples of adequate data structures can be found in sample.csv and sample.xml files.
  • If you would like to upload product list files, sample PHP codes with some comments for developing can be found in create_xml.php, create_csv.php and send_product_list.php files that you can freely use and modify to your PHP system or framework.
  • The fatal_error.txt, products_with_errors.txt and products_ok.txt files are the sample results of the file processing with some comments. Language of result files is the same as you set as system language in Bidcage. You will receive the real results without comments in compressed ZIP format via e-mail.

Errors during product list file processing


  • FATAL ERRORS: when a fatal error happens, the entire product list processing will stop and no product will be created or update from the file. If the processing of product list will end with fatal error, the system will automatically switch the product list processing to test mode.
  • CRITICAL ERRORS: a critical error blocks the creation or update of the product inside system of Bidcage. If the number of critical errors reaches 100 pieces or 20% of products (whichever comes first) during a product list file processing, the system will automatically switch the product list processing to test mode.
  • SUB ERRORS: sub errors do not block the creation or update of a product inside system of Bidcage.
  • SUPENDING OF ACCEPTANCE OF PRODUCT LISTS: if a user's product list upload or download mode is continuously set to test mode by the system over consecutive processing of product lists, the user's product list acceptance will be suspended.

Elements of product list files


In the downloadable API library, the sample.csv and sample.xml files contain some sample products to show the proper use of the elements below.

  • identifier: REQUIRED, unique identifier or ID of products in your database. This must be unique for every single product per web store. Maximum 120 characters can be specified. Only one can be specified per product. In case of CSV files, identifier must be in the first position among data. Any error of identifier is critical and product will not be created or updated.
  • status: REQUIRED, the current availability of product. Boolean 1 or 0 value. Only one can be specified per product. If your system does not manage such type of data, simply add a 1 value to every product. If status is 0, it stops the automatic making of the offers until status will be set 1 again. If a previously updated product is not being in product list, status of that product is set to 0. If no product list is updated from a web store for 7 days, status of all products will be set 0. Any error of status is critical and product will not be created or updated.
  • product_url: REQUIRED, the URL of the product in your web store. Valid URL format. Only one can be specified per product. Note: if more subversions of a product (e.g. difference in color) are available with the same web address (URL), it is recommended to add the main differential feature to 'name' element so we can create the adequate product template for every different subversion. Any error of product_url is critical and product will not be created or updated.
    For example: https://www.example.com/product_url
  • category: REQUIRED, the hierarchical category path names of product in your web store. Text format, maximum 1000 characters can be specified. Only one can be specified per product. Missing of category is critical error and product will not be created or updated. If category is longer than 1000 characters, the end will be cut and only sub error is generated.
    For example: Consumer electronics > Mobile phones and accessories > Apple
  • language: REQUIRED, 3-letter language code of the product (lower and uppercase are also accepted). Only one can be specified per product. For our valid language codes, please click here. Any error of language is critical and product will not be created or updated.
    For example: eng
  • price: REQUIRED, the gross price of the product in your web store. Decimal number format with maximum one decimal point. Only one can be specified per product. With regular updating of prices, you can set automatic price adjustment in automatic offers and we can automatically starts products in group buys. In case of updating, price element will always be saved. Any error of price is critical and product will not be created or updated.
  • currency: REQUIRED, 3-letter currency code to the price of the product (lower and upper case are also accepted). Only one can be specified per product. For our valid currency codes, please click here. In case of updating, currency element will always be saved. Any error of currency is critical and product will not be created or updated.
    For example: USD
  • name: REQUIRED, the name or title of the product. Text format, maximum 120 characters can be specified. Only one can be specified per product. Missing of name is critical error and product will not be created or updated. If name is longer than 120 characters, the end will be cut and only sub error is generated.
    For example: Apple iPhone 7 - 32GB - GSM Unlocked - Rose Gold - MN8K2LL/A
  • manufacturer: CONDITIONAL, the manufacturer of the product. If the name includes the manufacturer, this element can be skipped. Text format, maximum 120 characters can be specified. Only one can be specified per product. Any error of manufacturer is only a sub error. If manufacturer is longer than 120 characters, the end will be cut.
    For example: Apple
  • stock: OPTIONAL, the available stock quantity in your inventory management system. Regularly updated stock can be used for automatic stock tracking in your automatic offers. If no stock was specified or the value was invalid it will not be updated. Integer number format, maximum 12 digits can be specified. Only one can be specified per product. Any error of stock is only a sub error.
  • size: OPTIONAL, only for clothing products, the size of product which is used in your web store. If different sizes are attached to a product, then create different products with the different sizes inside the file and you can differentiate the identifiers eg.: original: 123, divided according to size: 123a, 123b, 123c, etc. Size can help you identify different sizes of products at automatic piece price adjustment and automatic stock tracking a in your automatic offers. Size will always be changed when you specify its value in product list file. Text format, maximum 30 characters can be specified. Only one can be specified per product. Any error of size is only a sub error.
    For example: XL
  • description: OPTIONAL, the description of the product. Text format, maximum 10000 characters can be specified. Only one can be specified per product. Any error of description is only a sub error. If description is longer than 10000 characters, the end will be cut.
  • feature: OPTIONAL, the features of the product. If you store more ones in your database, you can add them one by one to the product (check out in downloaded sample files). If you store it as one longer text, you can add that only one to the product. Text format, maximum 10000 characters can be specified in all. Any error of feature is only a sub error. If all features is longer than 10000 characters, the end will be cut.
  • upc: OPTIONAL, Universal Product Code of the product. Integer format, between 6-12 digits length. Only one can be specified per product. Any error of upc is only a sub error.
  • ean: OPTIONAL, European/International Article Number (also known as GTIN Global Trade Item Number) of the product. Integer format, between 8-14 digits length. Only one can be specified per product. Any error of ean is only a sub error.
  • isbn: OPTIONAL, International Standard Book Number of the product (for books). Integer format, 10 or 13 digits length. Only one can be specified per product. Any error of isbn is only a sub error.
  • mpn: OPTIONAL, Manufacturer Part Number or identifier code of the product. Text format, maximum 120 characters can be set. Only one can be specified per product. Any error of mpn is only a sub error. If mpn is longer than 120 characters, the end will be cut.
  • image_url: OPTIONAL, maximum 5 images will be processed per product, more ones will be ignored (check out in downloaded sample files). Valid URL format. Any error of image_url is only a sub error. Alternatively, priority can be specified as well ie. image_url_1, image_url_2, image_url_3, image_url_4, image_url_5.
    For example: https://www.example.com/images/image_1.jpg

Current valid language and currency codes in system


To check out our valid codes, please click here.
jump to top
Our website uses cookies to improve the user experience, to make analytics and for personalized advertising. Cookies do not store or transmit personal data. You can find more information about the protection of your data in our Privacy Statement page.
Accept
I do not accept