Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


{
Function: getArticles
Description: get a list of products data WITHOUT IMAGE DATA itself. Use SOAP method getImage to get the image data.
Request
userxsd:string
passxsd:string
offsetxsd:string
blocksizexsd:string
filtertns:arrayOfString
indivFieldsListtns:indivFieldsList
orderBytns:arrayOfString   * requires Version 6.0.15
{
"function":"getArticles",
"paras":{
"user":"",
"pass":"",
"offset":"",
"blocksize":"",
"filter":[],
"indivFieldList":[],
"orderBy":["products_ean;DESC","products_price"]
}}
Response
resulttns:getArticlesResultItem
{
    "result":{
        "productsItemExportList":[{
                "products_id":0,
                "external_id":"",
                "permission_id":0,
                "products_owner":0,
                "products_ean":"",
                "products_quantity":0,
                "products_average_quantity":0,
                "products_shippingtime":0,
                "products_model":"",
                "price_flag_graduated_all":0,
                "price_flag_graduated_1":0,
                "price_flag_graduated_2":0,
                "price_flag_graduated_3":0,
                "products_sort":0,
                "products_option_master_price":"",
                "ekomi_allow":0,
                "products_image":"",
                "products_price":0,
                "date_added":"0001-01-01T00:00:00",
                "last_modified":"0001-01-01T00:00:00",
                "date_available":"0001-01-01T00:00:00",
                "products_weight":0,
                "products_status":0,
                "products_tax_class_id":0,
                "product_template":"",
                "product_list_template":"",
                "manufacturers_id":0,
                "products_ordered":0,
                "products_fsk18":0,
                "products_vpe":0,
                "products_vpe_status":0,
                "products_vpe_value":0,
                "products_startpage":0,
                "products_startpage_sort":0,
                "products_average_rating":0,
                "products_rating_count":0,
                "products_digital":0,
                "flag_has_specials":0,
                "products_serials":0,
                "products_master_flag":"",
                "products_master_model":"",
                "products_keywords":{
                    "de":"",
                    "en":""
                },
                "products_description":{
                    "de":"",
                    "en":""
                },
                "products_short_description":{
                    "de":"",
                    "en":""
                },
                "meta_description":{
                    "de":"",
                    "en":""
                },
                "meta_title":{
                    "de":"",
                    "en":""
                },
                "meta_keywords":{
                    "de":"",
                    "en":""
                },
                "seo_url":{
                    "de":"",
                    "en":""
                },
                "url":{
                    "de":"",
                    "en":""
                },
                "products_special_prices":[{
                        "special_price":0,
                        "status":0,
                        "date_available":"0001-01-01T00:00:00",
                        "date_expired":"0001-01-01T00:00:00",
                        "group_permissions":[],
                        "group_permission_all":0
                    }                ],
                "products_name":{
                    "de":"",
                    "en":""
                },
                "categories":[],
                "image_name":"",
                "image":"",
                "products_prices":[{
                        "price":0,
                        "staffel":0,
                        "group":"",
                        "quantity":0
                    }                ],
                "products_cross_sell":[],
                "products_images":[{
                        "type":"",
                        "id":"",
                        "image_name":"",
                        "image_data":""
                    }                ],
                "products_categories":[],
                "products_attributes":[{
                        "attributes_id":0,
                        "attributes_parent_id":0
                    }                ],
                "permissionList":[{
                        "external_id":"",
                        "permission":true,
                        "pgroup":""
                    }                ],
                "indivFieldsList":[{
                        "dstTable":"",
                        "sqlFieldName":"",
                        "sqlFieldType":"",
                        "value":"",
                        "langValue":{
                            "de":"",
                            "en":""
                        }
                    }                ],
                "products_media_urlList":[{
                        "type":"",
                        "file":"",
                        "width":"",
                        "height":"",
                        "folder":"",
                        "url":""
                    }                ]
            }        ],
        "result":true,
        "message":""
    }
}

...

Hinweis: Der Parameter 'filter' kann verwendet werden um auf einzelne oder mehrere Artikel zu selektieren. Es können derzeit alle Felder innerhalb der Tabelle 'TABLE_PRODUCTS' abgefragt werden. 

Für die Filter-Funktion werden die Operatoren > = < und % unterstützt - wobei % in der Abfrage auf FELD LIKE %xxx% aufgelöst wird.


Beispiele:

Abfrage aller Artikel mit Lagerbestand = 0

Code Block
{
    "function": "getArticles",
    "paras": {
        "user": "{{api_user}}",
        "pass": "{{api_password}}",
        "offset":"0",
        "blocksize":"50",
        "filter":["products_quantity=0"],
        "indivFieldList":[]
    }
}

Abfrage aller Artikel mit einer Like Bedingung (alle produkte mit "abc" in der Artikelnummer)

Code Block
{
    "function": "getArticles",
    "paras": {
        "user": "{{api_user}}",
        "pass": "{{api_password}}",
        "offset":"0",
        "blocksize":"50",
        "filter":["products_model%abc"],
        "indivFieldList":[]
    }
}

...