updateCategories |
  
|
updateCategories |
|
Create and update groups of goods. These are important to inherit relevant information for the creation of offers and are a best practice approach.
For additional Growth options see also the full updateCategories call. |
<request version="1.0.0" method="updateCategories"> <category significant_key="external_id"> <mandator_id>1</mandator_id> <identifier>webservice subcategory</identifier> <external_id>ws_subcat</external_id> <external_parent_id>ws_maincat</external_parent_id> </category> </request> |
Name |
Description |
Occ. |
Type |
Value Info |
|---|---|---|---|---|
request |
Root-Element of request |
1 |
Element |
|
method |
Attribute of request. Name of Webservice-Method. |
1 |
string |
Fixed value: „updateCategories“ |
version |
Attribute of request. Version control of request. |
1 |
integer |
Fixed value: „1.0.0“ |
category |
Wrapper-Element, summarizing the data of a group of good. |
0..N |
Element |
|
significant_key |
Selected identifier for group of goods updates. |
1 |
string |
Fixed value: „external_id“ |
mandator_id |
ID of client. |
1 |
integer |
|
identifier |
Unique group of goods identifier. |
1 |
string |
Length: 0 – 100 characters |
external_id |
External ID to create and update groups of goods. ID managed by external system. |
0..1 |
string |
Length: 0 – 50 characters |
external_parent_id |
External ID of parent group of goods. |
0..1 |
string |
Length: 0 – 50 characters |
<response method="updateCategories" version="1.0.0"> <report return_code="<0"> <error_description>Detailed error description in the language of the mandator language setting</error_description> </report> </response> |
Name |
Description |
Occ. |
Type |
Value Info |
|---|---|---|---|---|
response |
Root-element of response |
1 |
Element |
|
method |
Attribute of response. Name of Webservice-Method. |
1 |
string |
Fixed value: „updateCategories“ |
version |
Attribute of response. Version control of request. |
1 |
integer |
Fixed value: „1.0.0“ |
report |
Information about executed operation. A report element is returned for each requested category element. |
0..N |
Element |
|
return_code |
Attribute of report. Identifies error reason code. |
1 |
integer |
0 = OK. < 0 = error |
error_description |
Describes errors and error reasons of executed operation, once appeared. |
0..1 |
string |
•If an entry with the value of the significant key does exist, an update will occur. If the value does not exist, a new entry will be created. |
Version |
Change Description |
|---|---|
4.8.46 |
Introduction of a Basic "Simplified" Integration |