Speed4Trade CONNECT API 2.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Navigation: Processes & Formats > Exports

OfferExport

Description:

With this process, offers can be submitted to the trading platform. For this purpose, Speed4Trade CONNECT provides an XML format for offers. This is a base export and the type of offer is a parameter in the job options.

How offers can be export?

•Export all offers to local path on Speed4Trade CONNECT server

•Export offers as delta to local path on Speed4Trade CONNECT server

•Export all offers to (s)ftp account (ftp server can be configured in Speed4Trade CONNECT)

•Export offer as delta to (s)ftp account (ftp server can be configured in Speed4Trade CONNECT)

•Export only active offers to (s)ftp account (ftp server can be configured in Speed4Trade CONNECT)

This export contains all informations according to the accounts mapping.

Fieldlist:

Name	Type	Cardinality	Description
offers	Element	1	Element that combines the data of offers. It can contain several elements of offer.
offer	Element	1..N	Element that contains all the data of one offer.
title	string	0..1	Title of the offer.
item_identifier	string	0..1	Identifier of the item. Can be used for matching.
item_internal_number	string	0..1	Internal number of the item. Can be used for matching.
item_match_code	string	0..1	Matchcode of the item. Can be used for matching.
item_ean_code	string	0..1	EAN number of the item. Can be used for matching.
item_upc_code	string	0..1	UPC number of the item. Can be used for matching.
item_isbn	string	0..1	ISBN number of the item. Can be used for matching.
account_name	string	0..1	Name of the account.
price	decimal	0..1	Price of the offer according to the accounts first pricelist.
account_price	decimal	0..1	Price of the offer depending on the pricelist of the offers account.
prices	Element	0..1	Element that combines the data of pricelist items. It can contain several elements pricelist.
pricelist	Element	1..N	Pricelist element according to the accounts pricelist mappings.
identifier	string	1	Identifier attribute of the pricelist element.
external_id	string	1	External ID attribute of the pricelist element.
price	decimal	1	Price attribute for the offer item according to the current pricelist element.
offer_state	string	0..1	State of the offer. See table of values below for further description.
offer_pending_state	string	0..1	Sub-state of the offer. (e.g. manually ended offer or offer ended by IABA)
delivery_time_identifier	string	0..1	Identifier of the delivery time.
delivery_time_in_days	integer	0..1	Number of days corresponding the delivery time.
product_group_external_id	string	0..1	External ID of the product group.
product_group_identifier	string	0..1	Identifier of the product group.
vendor_external_id	string	0..1	External ID of the vendor.
vendor_identifier	string	0..1	Identifier of the vendor.
vendor_item_number	string	0..1	Item number of the vendor.
variant_parent_identifier	string	0..1	Identifier of the parent item variant. Can be used for matching.
variant_parent_internal_item_number	string	0..1	Internal number of the parent item variant. Can be used for matching.
variant_parent_match_code	string	0..1	Matchcode of the parent item variant. Can be used for matching.
variant_parent_ean	string	0..1	EAN of the parent item variant. Can be used for matching.
variant_parent_upc	string	0..1	UPC of the parent item variant. Can be used for matching.
variant_parent_isbn	string	0..1	ISBN of the parent item variant. Can be used for matching.
delivery_charge_category_external_id	string	0..1	External ID of the delivery charge category.
delivery_charge_category_identifier	string	0..1	Identifier of the delivery charge category.
variable_field	string	0..1	Variable field
catalog_price	decimal	0..1	List price of the item.
is_coupon	boolean	0..1	Indicates whether this item is a coupon or not.
is_adult_product	boolean	0..1	Indicates whether this item is for adults.
length	decimal	0..1	Length of the item.
width	decimal	0..1	Width of the item.
height	decimal	0..1	Height of the item.
weight	decimal	0..1	Weight of the item.
area	decimal	0..1	Area of the item.
volume	decimal	0..1	Volume of the item.
piece	decimal	0..1	Piece of the item.
wrapping_length	decimal	0..1	Length of the wrapping.
wrapping_width	decimal	0..1	Width of the wrapping.
wrapping_height	decimal	0..1	Height of the wrapping.
wrapping_weight	decimal	0..1	Weight of the wrapping.
size_unit	string	0..1	Defines the unit of measurement for the size (length, width, height). See table of values below for further description.
weight_unit	string	0..1	Defines the unit of measurement for the weight. See table of values below for further description.
area_unit	string	0..1	Defines the unit of measurement for the area. See table of values below for further description.
volume_unit	string	0..1	Defines the unit of measurement for the volume. See table of values below for further description.
piece_unit	string	0..1	Defines the unit of measurement for the piece.
base_price	string	0..1	Base price of the item. (e.g. '5.99 EUR / 100 ml', '5.50 EUR per piece', '7.45 EUR / kg')
base_price_unit	string	0..1	Defines the unit of the base price.
wrapping_size_unit	string	0..1	Size unit of the wrapping.
wrapping_weight_unit	string	0..1	Weight unit of the wrapping.
packaging_unit	integer	0..1	Packaging unit in pieces.
package_count	integer	0..1	Quantity of packages.
stock	integer	0..1	Stock of the item.
tax_country_iso_code	string	0..1	ISO 639-1 language code
tax_percentage	decimal	0..1	Tax rate in percent
tax_type_identifier	string	0..1	Type of the tax. See table of values below for further description.
tax_country_specific_identifier	string	0..1	Specific identifier of the tax.
image_modules	Element	0..1	Element that combines the data of image modules. It can contain several elements of image_module.
image_module	Element	1..N	Element that contains all the data of one image module.
module_identifier	string	1	Identifier of the image module.
url	string	0..1	Url of the image module.
rank	integer	0..1	Sorting number of the image module.
text_modules	Element	0..1	Element that combines the data of text modules. It can contain several elements of text_module.
text_module	Element	1..N	Element that contains all the data of one text module.
module_identifier	string	1	Identifier of the text module.
text	string	0..1	Text of the text module.
language	string	0..1	ISO 639-1 language code.
rank	integer	0..1	Sorting number of the text module.
media_modules	Element	0..1	Element that combines the data of media modules. It can contain several elements of media_module.
media_module	Element	1..N	Element that contains all the data of one media module.
module_identifier	string	1	Identifier of the media module.
url	string	0..1	Url of the media module.
rank	integer	0..1	Sorting number of the media module.
item_attributes	Element	0..1	Element that combines the data of item attributes. It can contain several elements of item_attribute.
item_attribute	Element	1..N	Element that contains all the data of one item attribute.
attribute_identifier	string	0..1	Identifier of the item attribute.
value_identifier	string	0..1	Value of the item attribute.
language_data_list	Element	0..1	Element that combines the translation data for one attribute value identifier. It can contain several elements of language_data. One element per language.
language_data	Element	1..N	Element that contains all translations for one variant attribute value identifier.
text	string	0..1	One translation of the value identifier.
language	string	0..1	ISO 639-1 language code.
specific_attribute_identifier	string	0..1	Specific identifier of the item attribute.
specific_value_identifier	string	0..1	Specific identifier of the item attribute value.
variant_attributes	Element	0..1	Element that combines the data of variant attributes. It can contain several elements of variant_attribute.
variant_attribute	Element	1..N	Element that contains all the data of one variant attribute.
attribute_identifier	string	0..1	Identifier of the variant attribute.
value_identifier	string	0..1	Value of the variant attribute.
language_data_list	Element	0..1	Element that combines the translation data for one attribute value identifier. It can contain several elements of language_data. One element per language.
language_data	Element	1..N	Element that contains all translations for one variant attribute value identifier.
text	string	0..1	One translation of the value identifier.
language	string	0..1	ISO 639-1 language code.
specific_attribute_identifier	string	0..1	Specific identifier of the variant attribute.
specific_value_identifier	string	0..1	Specific identifier of the variant attribute value.
cross_selling_items	Element	0..1	Element that combines the data of cross-selling items. It can contain several elements of cross_selling_item.
cross_selling_item	Element	1..N	Element that contains all the data of one cross-selling item.
identifier	string	0..1	Identifier of the cross-selling item. Can be used for matching.
internal_item_number	string	0..1	Internal number of the cross-selling item. Can be used for matching.
match_code	string	0..1	Matchcode of the cross-selling item. Can be used for matching.
ean_code	string	0..1	EAN of the cross-selling item. Can be used for matching.
upc_code	string	0..1	UPC of the cross-selling item. Can be used for matching.
isbn	string	0..1	ISBN of the cross-selling item. Can be used for matching.
cross_selling_type	string	0..1	Type of the cross-selling item. See table of values below for further description.
set_items	Element	0..1	Element that combines the data of set items. It can contain several elements of set_item.
set_item	Element	1..N	Element that contains all the data of one set_item.
identifier	string	0..1	Identifier of the set item. Can be used for matching.
internal_item_number	string	0..1	Internal number of the set item. Can be used for matching.
match_code	string	0..1	Matchcode of the set item. Can be used for matching.
ean_code	string	0..1	EAN of the set item. Can be used for matching.
upc_code	string	0..1	UPC of the set item. Can be used for matching.
isbn	string	0..1	ISBN of the set item. Can be used for matching.
quantity	integer	0..1	Quantity of the set item.
marketplace_categories	Element	0..1	Element that combines the data of marketplace categories. It can contain several elements of marketplace_category.
marketplace_category	Element	1..N	Element that contains all the data of one marketplace category.
identifier	string	0..1	Identifier of the marketplace category. Can be used for matching.
external_id	string	0..1	External ID of the marketplace category. Can be used for matching.
parent_identifier	string	0..1	Parent identifier of the marketplace category.
parent_external_id	string	0..1	Parent external ID of the marketplace category.
subchannel_identifier	string	0..1	Subchannel identifier of the marketplace category.
channel_identifier	string	0..1	Channel identifier of the marketplace category.

Table of Values - offer_state:

Value	Description
PREPARED	Offers which were generated (not included in export)
SCHEDULED	Offers which are released for export and added
ACTIVE	Active offers
ENDED_MINIMUM_STOCK_LEVEL	Terminated offers which are not valid (if included in delta the offer need to be delete)
ENDED_SAFETY_STOCK_LEVEL	Terminated offers which have reached the safety stock (if included in delta the offer need to be delete)
ENDED_MANUALLY	Terminated offers which were terminated by the user (if included in delta the offer need to be delete)
ENDED_SCHEDULED_TO_RELIST	Finished offers which were released again for upload
ENDED_RELIST_FAILED	Terminated offers whose re-upload failed

Table of Values - tax_type_identifier

Value
free
reduced
normal

Table of Values - cross_selling_type

Value	Description
CROSS_SELLING	The item is a cross selling item.
UP_SELLING	The item is a up selling item.

Table of Values - weight_unit

Value
g
kg
t
oz.tr.
oz.
pd.

Table of Values - area_unit

Value
mm²
cm²
dm²
m²
sq. in.
sq. ft.
sq. yd.
sq.

Table of Values - volume_unit

Value
mm³
cm³
dm³
m³
cu. in.
cu. ft.
cu. yd.
ml
cl
l
fl. oz.
pt.
qt.
gal.

Table of Values - size_unit

Value
mm
cm
dm
m
in.
ft.
yd.

Example Offer:

<?xml version="1.0" encoding="UTF-8"?>
<offers>
  <offer>
    <title>Verschleissteil 0001 neu</title>
    <item_identifier>Verschleissteil 0001</item_identifier>
    <item_internal_number>II-7222</item_internal_number>
    <item_match_code>MC_872364</item_match_code>
    <item_ean_code>5901234123457</item_ean_code>
    <item_upc_code>036000291452</item_upc_code>
    <item_isbn>9783161484100</item_isbn>
    <account_name>Accountname</account_name>
    <price>49.99</price>
    <account_price>49.99</account_price>
    <prices>
      <pricelist identifier="gross_pricelist" external_id="ext-pricelist1" price="49.99"/>
    </prices>

<offer_state>ACTIVE</offer_state>

<offer_pending_state>ACTIVE</offer_pending_state>
<delivery_time_identifier>1-2 Tage</delivery_time_identifier>

<delivery_time_in_days>1</delivery_time_in_days>

<variant_parent_identifier>Variant parent 12345</variant_parent_identifier>

    <variant_parent_internal_item_number>VAR12345</variant_parent_internal_item_number>
    <variant_parent_match_code></variant_parent_match_code>
    <variant_parent_ean></variant_parent_ean>
    <variant_parent_upc></variant_parent_upc>
    <variant_parent_isbn></variant_parent_isbn>
    <product_group_external_id>Teile</product_group_external_id>

<product_group_identifier>Parts</product_group_identifier>

<delivery_charge_category_external_id>Paket</delivery_charge_category_external_id>

    <delivery_charge_category_identifier>Paket</delivery_charge_category_identifier>
    <vendor_external_id>28374</vendor_external_id>
    <vendor_identifier>BMW</vendor_identifier>
    <vendor_item_number>204D1</vendor_item_number>
    <variable_field/>
    <catalog_price>59.99</catalog_price>
    <is_coupon>false</is_coupon>
    <is_adult_product>false</is_adult_product>
    <length>500.00</length>
    <width>100.00</width>
    <height>450.00</height>
    <weight>30000.00</weight>

    <wrapping_length></wrapping_length>
    <wrapping_width></wrapping_width>
    <wrapping_height></wrapping_height>
    <wrapping_weight></wrapping_weight>
    <wrapping_size_unit>mm</wrapping_size_unit>
    <wrapping_weight_unit>g</wrapping_weight_unit>

    <base_price>2.00</base_price>
    <base_price_unit>per 1kg</base_price_unit>
    <packaging_unit>0</packaging_unit>

    <package_count>1</package_count>
    <stock>100</stock>
    <tax_country_iso_code>DE</tax_country_iso_code>
    <tax_percentage>19.00</tax_percentage>
    <tax_type_identifier>normal</tax_type_identifier>
    <tax_country_specific_identifier>normal</tax_country_specific_identifier>

    <image_modules>
      <image_module>
        <module_identifier>Listenbild</module_identifier>
        <url>https://connect-demo-media.speed4trade.com/bilder/test.jpg</url>
        <rank>1</rank>
      </image_module>
      <image_module>
        <module_identifier>Bild 1</module_identifier>
        <url>https://connect-demo-media.speed4trade.com/bilder/test.jpg</url>
        <rank>2</rank>
      </image_module>
    </image_modules>
    <text_modules>
      <text_module>
        <module_identifier>Titel</module_identifier>
        <text>Bremse 815 für 4711</text>
        <language>de</language>
        <rank>1</rank>
      </text_module>
    </text_modules>
    <media_modules>
      <media_module>
        <module_identifier>Medienbausteintyp 1</module_identifier>
        <url>http://medium-test.de</url>
        <rank>1</rank>
      </media_module>
    </media_modules>
    <cross_selling_items>
      <cross_selling_item>
        <identifier>Bremse 820 für 4720</identifier>
        <internal_item_number>1765145</internal_item_number>
        <match_code>1765145</match_code>
        <ean_code>1645192094165</ean_code>
        <upc_code>1765145</upc_code>
        <isbn>1765145</isbn>
        <cross_selling_type>Cross-Selling</cross_selling_type>
      </cross_selling_item>
    </cross_selling_items>
    <set_items>
      <set_item>
        <identifier>Bremsscheibe</identifier>
        <internal_item_number>3 397 015 302_BOSCH</internal_item_number>
        <match_code>3 397 015 302_BOSCH</match_code>
        <ean_code>1645192094246</ean_code>
        <upc_code>3 397 015 302_BOSCH</upc_code>
        <isbn>3 397 015 302_BOSCH</isbn>
        <quantity>1</quantity>
      </set_item>
    </set_items>
    <item_attributes>
      <item_attribute>
        <attribute_identifier>Teile-Beschreibung</attribute_identifier>
        <value_identifier>Bremse 815 für 4711</value_identifier>

        <language_data_list>
          <language_data>
            <text>Break 815 for 4711</text>
            <language>en</language>
          </language_data>
        </language_data_list>
        <specific_attribute_identifier>PARTS_DESCRIPTION</specific_attribute_identifier>
        <specific_value_identifier>Break 815 for 4711</specific_value_identifier>
      </item_attribute>
    </item_attributes>
    <variant_attributes>
      <variant_attribute>
        <attribute_identifier>Farbe</attribute_identifier>
        <value_identifier>rot</value_identifier>
        <language_data_list>
          <language_data>
            <text>Rot</text>
            <language>de</language>
          </language_data>
        </language_data_list>
        <specific_attribute_identifier>Colour</specific_attribute_identifier>
        <specific_value_identifier>rouge</specific_value_identifier>
      </variant_attribute>
    </variant_attributes>
    <marketplace_categories>
      <marketplace_category>
        <identifier>Bremsen</identifier>
        <external_id/>
        <parent_identifier>Verschleissteil</parent_identifier>
        <parent_external_id>PARTS</parent_external_id>
        <subchannel_identifier>My own shop</subchannel_identifier>

        <channel_identifier>Online Shops</channel_identifier>
      </marketplace_category>
    </marketplace_categories>
  </offer>
</offers>