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:
Element | Main Element | Description | DataType |
Products | A collection of all products | Collection | |
Product | Products | A representation of a single product with it's variants | String |
ProductId | Product | The unique Id of the Product | Integer |
Locals | Product | A collection of all translations of the product in the available languages. | Collection |
Local | Locals | A representation of a single language of a Product | Collection |
Language | Product | The language represented with a language identifier. Ex. "en" = English, "no" = Norwegian | Char(2) |
Name | Product | The name of the product represented by the Language | String |
ShortDescription | Product | A brief description of the Product represented by the Language | String |
FullDescription | Product | A full description of the Product represented by Language | String |
Images | Product | A collection of images represented by the Product | Collection |
Image | Images | A representation of a single image for the Product. The image is presented through a URL to the original image uploaded | URL |
Variants | Product | A collection of Product Variants | Collection |
Variant | Variants | A representation of a Products single variation | Collection |
SKU | Variant | The SKU of a product Variant | String |
VariantID | Variant | The unique identification number for a Product Variant | Integer |
Locals | Variant | A collection of all translations of the Product Variant in the available languages | Collection |
Local | Locals | A representation of a single language for a Product Variant | Collection |
Language | Local | The language represented with a language identifier. Ex. "en" = English, "no" = Norwegian | Char(2) |
Name | Variant | The Name of the Product Variant represented by the Language | String |
Description | Variant | A full description of the Product Variant represented by the Language | String |
Prices | Variant | A collection of prices in available currencies for the Product Variant | Collection |
Price | Variant | A Price for a singe Product Variant represented by its Currency. The Currency is stated by its Currency code | Double |
Categories | Product | A collection of Categories for the Product | Collection |
Language | Category | The language of the Category | Char(2) |
Category | Categories | A representation of a single Category presented by Language | String |