Methods

  • get - Get Products
  • post - Search Products
  • put - Update Product

Properties

{
    "addonValues": {
        "ageGroup": "string",
        "brandName": "string",
        "codeIsbn": "string",
        "codeJan": "string",
        "codeMpn": "string",
        "codeUpc": "string",
        "expirationDate": "string",
        "gender": "string",
        "googleExportAvailabilityId": "string",
        "googleExportCondition": "string",
        "identifierExists": "string",
        "productsImageHeight": "string",
        "productsImageWidth": "string"
    },
    "checkoutInformation": {
        "de": "string",
        "en": "string"
    },
    "dateAdded": "string",
    "dateAvailable": "string",
    "description": {
        "de": "string",
        "en": "string"
    },
    "discountAllowed": "int64",
    "ean": "string",
    "id": "int64",
    "images": [
        {
            "filename": "string",
            "imageAltText": {
                "de": "string",
                "en": "string"
            },
            "isPrimary": "boolean",
            "isVisible": "boolean"
        }
    ],
    "infoUrl": {
        "de": "string",
        "en": "string"
    },
    "isActive": "boolean",
    "isFsk18": "boolean",
    "isVpeActive": "boolean",
    "keywords": {
        "de": "string",
        "en": "string"
    },
    "lastModified": "string",
    "manufacturerId": "int64",
    "metaDescription": {
        "de": "string",
        "en": "string"
    },
    "metaKeywords": {
        "de": "string",
        "en": "string"
    },
    "metaTitle": {
        "de": "string",
        "en": "string"
    },
    "name": {
        "de": "string",
        "en": "string"
    },
    "orderedCount": "int64",
    "price": "float",
    "productModel": "string",
    "productTypeId": "int64",
    "quantity": "int64",
    "quantityUnitId": "int64",
    "settings": {
        "detailsTemplate": "string",
        "graduatedQuantity": "int64",
        "groupPermissions": [
            {
                "id": "int64",
                "isPermitted": "boolean"
            }
        ],
        "minOrder": "int64",
        "onSitemap": "boolean",
        "optionsDetailsTemplate": "string",
        "optionsListingTemplate": "string",
        "priceStatus": "int64",
        "propertiesCombisQuantityCheckMode": "int64",
        "propertiesDropdownMode": "string",
        "showAddedDateTime": "boolean",
        "showOnStartpage": "boolean",
        "showPriceOffer": "boolean",
        "showPropertiesPrice": "boolean",
        "showQuantityInfo": "boolean",
        "showWeight": "boolean",
        "sitemapChangeFrequency": "string",
        "sitemapPriority": "string",
        "startpageSortOrder": "int64",
        "usePropertiesCombisShippingTime": "boolean",
        "usePropertiesCombisWeight": "boolean"
    },
    "shippingCosts": "float",
    "shippingTimeId": "int64",
    "shortDescription": {
        "de": "string",
        "en": "string"
    },
    "sortOrder": "int64",
    "specialOfferId": "int64",
    "taxClassId": "int64",
    "url": {
        "de": "string",
        "en": "string"
    },
    "urlKeywords": {
        "de": "string",
        "en": "string"
    },
    "viewedCount": {
        "de": "int64",
        "en": "int64"
    },
    "vpeId": "int64",
    "vpeValue": "int64",
    "weight": "float"
}
{
    "addonValues": {
        "productsImageHeight": "0",
        "productsImageWidth": "0"
    },
    "checkoutInformation": {
        "de": "",
        "en": ""
    },
    "dateAdded": "2015-08-08 17.19:46",
    "dateAvailable": "2016-01-21 12:15:42",
    "description": {
        "de": "[TAB:Seite 1] Testartikel Beschreibung Seite 1 [TAB:Seite 2] Testartikel Beschreibung\nSeite 2 [TAB:Seite 3] Testartikel Beschreibung Seite 3",
        "en": "<p>Test product description.</p>"
    },
    "discountAllowed": 0,
    "ean": "",
    "images": [
        {
            "filename": "artikelbild_1_1.jpg",
            "imageAltText": {
                "de": "",
                "en": ""
            },
            "isPrimary": false,
            "isVisible": true
        },
        {
            "filename": "artikelbild_1_2.jpg",
            "imageAltText": {
                "de": "",
                "en": ""
            },
            "isPrimary": false,
            "isVisible": true
        },
        {
            "filename": "artikelbild_1_3.jpg",
            "imageAltText": {
                "de": "",
                "en": ""
            },
            "isPrimary": false,
            "isVisible": true
        }
    ],
    "isActive": false,
    "isFsk18": false,
    "isVpeActive": false,
    "keywords": {
        "de": "",
        "en": ""
    },
    "lastModified": "2016-03-16 16:01:51",
    "manufacturerId": 0,
    "metaDescription": {
        "de": "",
        "en": ""
    },
    "metaKeywords": {
        "de": "",
        "en": ""
    },
    "metaTitle": {
        "de": "",
        "en": ""
    },
    "name": {
        "de": "Testartikel",
        "en": "Test Product"
    },
    "orderedCount": 1,
    "price": 16.7983,
    "productModel": "ABC123",
    "productTypeId": 1,
    "quantity": 998,
    "quantityUnitId": 0,
    "settings": {
        "detailsTemplate": "standard.html",
        "graduatedQuantity": 1,
        "minOrder": 1,
        "onSitemap": true,
        "optionsDetailsTemplate": "product_options_dropdown.html",
        "optionsListingTemplate": "product_options_dropdown.html",
        "priceStatus": 0,
        "propertiesDropdownMode": "dropdown_mode_1",
        "showAddedDateTime": false,
        "showOnStartpage": false,
        "showPriceOffer": true,
        "showPropertiesPrice": true,
        "showQuantityInfo": true,
        "showWeight": false,
        "sitemapChangeFrequency": "daily",
        "sitemapPriority": "0.5",
        "startpageSortOrder": 0,
        "usePropertiesCombisQuantity": false,
        "usePropertiesCombisShippingTime": true,
        "usePropertiesCombisWeight": false
    },
    "shippingCosts": 0,
    "shippingTimeId": 1,
    "shortDescription": {
        "de": "<p>Testartikel Kurzbeschreibung</p>",
        "en": "<p>Test product short description.</p>"
    },
    "sortOrder": 0,
    "taxClassId": 1,
    "url": {
        "de": "",
        "en": ""
    },
    "urlKeywords": {
        "de": "testartikel",
        "en": "test-product"
    },
    "viewedCount": {
        "de": 32,
        "en": 0
    },
    "vpeID": 0,
    "vpeValue": 0,
    "weight": 0
}
Name Type Description Additional
addonValues object GXProductAddonValues Required
addonValues.ageGroup string Optional
addonValues.brandName string Optional
addonValues.codeIsbn string Optional
addonValues.codeJan string Optional
addonValues.codeMpn string Optional
addonValues.codeUpc string Optional
addonValues.expirationDate string Optional
addonValues.gender string Optional
addonValues.googleExportAvailabilityId string Optional
addonValues.googleExportCondition string Optional
addonValues.identifierExists string Optional
addonValues.productsImageHeight string Required
addonValues.productsImageWidth string Required
checkoutInformation object GXMultiLangOption Required
checkoutInformation.de string Required
checkoutInformation.en string Required
dateAdded string Required
dateAvailable string Required
description object GXMultiLangOption Required
description.de string Required
description.en string Required
discountAllowed int64 Required
ean string Required
id int64 Optional , read only.
images[] array Optional
images[].filename string Required
images[].imageAltText object GXMultiLangOption Required
images[].imageAltText.de string Required
images[].imageAltText.en string Required
images[].isPrimary boolean Required
images[].isVisible boolean Required
infoUrl object GXMultiLangOption Required
infoUrl.de string Required
infoUrl.en string Required
isActive boolean Required
isFsk18 boolean Required
isVpeActive boolean Required
keywords object GXMultiLangOption Required
keywords.de string Required
keywords.en string Required
lastModified string Required
manufacturerId int64 Required
metaDescription object GXMultiLangOption Required
metaDescription.de string Required
metaDescription.en string Required
metaKeywords object GXMultiLangOption Required
metaKeywords.de string Required
metaKeywords.en string Required
metaTitle object GXMultiLangOption Required
metaTitle.de string Required
metaTitle.en string Required
name object GXMultiLangOption Required
name.de string Required
name.en string Required
orderedCount int64 Required
price float

The product's net price

Required
productModel string Required
productTypeId int64 Required
quantity int64 Required
quantityUnitId int64 Required
settings object GXProductSettings Required
settings.detailsTemplate string Required
settings.graduatedQuantity int64 Required
settings.groupPermissions[] array Required
settings.groupPermissions[].id int64 Optional , read only.
settings.groupPermissions[].isPermitted boolean Required
settings.minOrder int64 Required
settings.onSitemap boolean Required
settings.optionsDetailsTemplate string Required
settings.optionsListingTemplate string Required
settings.priceStatus int64

Provide: "0" for normal, "1" for price on request and "2" for not available for purchase.

Required
settings.propertiesCombisQuantityCheckMode int64 Required
settings.propertiesDropdownMode string Required
settings.showAddedDateTime boolean Required
settings.showOnStartpage boolean Required
settings.showPriceOffer boolean Required
settings.showPropertiesPrice boolean Required
settings.showQuantityInfo boolean Required
settings.showWeight boolean Required
settings.sitemapChangeFrequency string Required
settings.sitemapPriority string Required
settings.startpageSortOrder int64 Required
settings.usePropertiesCombisShippingTime boolean Required
settings.usePropertiesCombisWeight boolean Required
shippingCosts float Required
shippingTimeId int64 Required
shortDescription object GXMultiLangOption Required
shortDescription.de string Required
shortDescription.en string Required
sortOrder int64 Required
specialOfferId int64 Optional
taxClassId int64 Required
url object GXMultiLangOption Required
url.de string Required
url.en string Required
urlKeywords object GXMultiLangOption Required
urlKeywords.de string Required
urlKeywords.en string Required
viewedCount object GXMultiLangIntOption Required
viewedCount.de int64 Required
viewedCount.en int64 Required
vpeId int64 Required
vpeValue int64 Required
weight float Required