Not logged in - Login
< back

Product XML API

WebshopAPI/GetProducts

This is a response from a request to get all active products on a website. The request will be sent to http://www.yourdomain.com/API/WebshopAPI/GetProducts?token={token}.

Please request a token from your contact agent.


The response will have the following elements:

ElementMain ElementDescriptionDataType
Products A collection of all productsCollection
ProductProductsA representation of a single product with it's variantsString
ProductIdProductThe unique Id of the ProductInteger
LocalsProductA collection of all translations of the product in the available languages.Collection
LocalLocalsA representation of a single language of a ProductCollection
LanguageProductThe language represented with a language identifier.
Ex. "en" = English, "no" = Norwegian
Char(2)
NameProductThe name of the product represented by the LanguageString
ShortDescriptionProductA brief description of the Product represented by the LanguageString
FullDescriptionProductA full description of the Product represented by LanguageString
ImagesProductA collection of images represented by the ProductCollection
ImageImagesA representation of a single image for the Product. The image is presented through a URL to the original image uploadedURL
VariantsProductA collection of Product VariantsCollection
VariantVariantsA representation of a Products single variationCollection
SKUVariantThe SKU of a product VariantString
VariantIDVariantThe unique identification number for a Product VariantInteger
LocalsVariantA collection of all translations of the Product Variant in the available languagesCollection
LocalLocalsA representation of a single language for a Product VariantCollection
LanguageLocalThe language represented with a language identifier.
Ex. "en" = English, "no" = Norwegian
Char(2)
NameVariantThe Name of the Product Variant represented by the LanguageString
DescriptionVariantA full description of the Product Variant represented by the LanguageString
PricesVariantA collection of prices in available currencies for the Product VariantCollection
PriceVariantA Price for a singe Product Variant represented by its Currency. The Currency is stated by its Currency codeDouble
CategoriesProductA collection of Categories for the ProductCollection
LanguageCategoryThe language of the CategoryChar(2)
CategoryCategoriesA representation of a single Category presented by LanguageString