Methods

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

Properties

{
    "addonValues": {
        "ccCvv": "string",
        "ccExpires": "string",
        "ccIssue": "string",
        "ccNumber": "string",
        "ccOwner": "string",
        "ccStart": "string",
        "ccType": "string",
        "customerIp": "string",
        "downloadAbandonmentStatus": "string",
        "serviceAbandonmentStatus": "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": "string",
                "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": "int64",
    "shippingTimeId": "int64",
    "shortDescription": {
        "de": "string",
        "en": "string"
    },
    "sortOrder": "int64",
    "taxClassId": "int64",
    "url": {
        "de": "string",
        "en": "string"
    },
    "urlKeywords": {
        "de": "string",
        "en": "string"
    },
    "viewedCount": {
        "de": "string",
        "en": "string"
    },
    "vpeId": "int64",
    "vpeValue": "int64",
    "weight": "int64"
}
{
    "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 GXOrderAddonValues
addonValues.ccCvv string
addonValues.ccExpires string
addonValues.ccIssue string
addonValues.ccNumber string
addonValues.ccOwner string
addonValues.ccStart string
addonValues.ccType string
addonValues.customerIp string
addonValues.downloadAbandonmentStatus string
addonValues.serviceAbandonmentStatus string
checkoutInformation object GXMultiLangOption
checkoutInformation.de string Optional
checkoutInformation.en string Optional
dateAdded string
dateAvailable string
description object GXMultiLangOption
description.de string Optional
description.en string Optional
discountAllowed int64
ean string
id int64 Optional, read only.
images[] array Optional
images[].filename string
images[].imageAltText object GXMultiLangOption
images[].imageAltText.de string Optional
images[].imageAltText.en string Optional
images[].isPrimary boolean
images[].isVisible boolean
infoUrl object GXMultiLangOption
infoUrl.de string Optional
infoUrl.en string Optional
isActive boolean
isFsk18 boolean
isVpeActive boolean
keywords object GXMultiLangOption
keywords.de string Optional
keywords.en string Optional
lastModified string
manufacturerId int64
metaDescription object GXMultiLangOption
metaDescription.de string Optional
metaDescription.en string Optional
metaKeywords object GXMultiLangOption
metaKeywords.de string Optional
metaKeywords.en string Optional
metaTitle object GXMultiLangOption
metaTitle.de string Optional
metaTitle.en string Optional
name object GXMultiLangOption
name.de string Optional
name.en string Optional
orderedCount int64
price float

The product's net price

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

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

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