Records
Operations for records
Required Roles: ApiPublicQueries
The channel
The id for which the detailpage should be returned.
Use this parameter to override the geo setting "exclude products not in range" for this request.
Filters for field values of returned similar articles, recommendations, and pushed products.
Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.
idPossible values: If the value true is passed, then only the record IDs will be returned, streamlining the results. Additionally, if the Geo module is enabled, the IDs of all markets the product is mapped to will be also included. If you do not need the other information in the results, this will help you to improve performance.
falseThe latitude coordinate of the current location.
The longitude coordinate of the current location.
Currently selected markets
The maximum number of variants to return for every record
5Use this parameter to override the geo setting "maximum distance" for this request.
Use this parameter to specify the number of recommendations you would like. The default value from the configuration is used if the parameter is not specified.
0Use this parameter to specify the number of similar articles you would like. The default value from the configuration is used if the parameter is not specified.
10Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.
Specifies whether the list of all existing markets and their distance to the search location should be included in the response. By default, the GEO setting "showMarkets" is applied.
This parameter is used to pass an id for the user session. This is important for recognising the user, if you want to trigger personalised campaigns, as well as for FACT-Finder tracking.
Allows the activation/deactivation of the personalization of queries. true = the search result will be personalized if the personalization module is activated and all other requirements are met; false = the search result will not be personalized.
trueThis parameter is used to pass a user id for personalization across sessions. Required for Loop54 integrations.
truetruetruetrueOK
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
Required Roles: ApiPublicQueries
The channel
The market ids.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
falseThe markets which should be updated
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
The ids of the markets which should be deleted.
falseThe ids of the markets which should be deleted.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
The product numbers of the records which should be returned.
Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.
falseOK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
falseThe records which should be inserted
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
falseThe records which should be updated
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
The ids from the records which should be deleted.
Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.
productNumberPossible values: falseThe ids of the records which should be deleted.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
Use this parameter to pass product ID(s) which should be compared.
If the value true is passed, then only the record IDs will be returned, streamlining the results. Additionally, if the Geo module is enabled, the IDs of all markets the product is mapped to will be also included. If you do not need the other information in the results, this will help you to improve performance.
falseUse this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
The product numbers of the records for which customer prices should be returned.
Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.
productNumberPossible values: OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
falseThe records which should be inserted
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
The ids from the records which should be deleted.
Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.
productNumberPossible values: falseThe ids of the records which should be deleted.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
The record ids of the records which should be returned
Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.
idPossible values: The maximum number of variants to return for every record
5Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
The product numbers of the records for which geo data should be returned.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
falseThe records which should be updated
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport
The channel
The ids from the records which should be deleted.
falseThe ids of the records which should be deleted.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
The record ids of the records which should be returned
Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.
idPossible values: Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.
idPossible values: Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.
The record ids of the records which should be returned.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
Use this parameter to override the geo setting "exclude products not in range" for this request.
Filters for field values of recommended records.
Use this parameter to pass product ID(s) for which you wish to obtain recommendations.
If the value true is passed, then only the record IDs will be returned, streamlining the results. Additionally, if the Geo module is enabled, the IDs of all markets the product is mapped to will be also included. If you do not need the other information in the results, this will help you to improve performance.
falseThe latitude coordinate of the current location.
The longitude coordinate of the current location.
Currently selected markets
Use this parameter to override the geo setting "maximum distance" for this request.
Use this parameter to specify the number of recommendations you would like. The default value from the configuration is used if the parameter is not specified.
0Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.
This parameter is used to pass an id for the user session. This is important for recognising the user, if you want to give him personalised recommendations, as well as for FACT-Finder tracking.
Allows the activation/deactivation of the personalization of queries. true = the search result will be personalized if the personalization module is activated and all other requirements are met; false = the search result will not be personalized.
trueThis parameter is used to pass a user id for personalization across sessions. Required for Loop54 integrations.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiPublicQueries
The channel
Use this parameter to override the geo setting "exclude products not in range" for this request.
Filters for field values of recommended records.
Use this parameter to pass the product ID for which you wish to obtain similar products.
Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.
If the value true is passed, then only the record IDs will be returned, streamlining the results. Additionally, if the Geo module is enabled, the IDs of all markets the product is mapped to will be also included. If you do not need the other information in the results, this will help you to improve performance.
falseThe latitude coordinate of the current location.
The longitude coordinate of the current location.
Currently selected markets
Use this parameter to override the geo setting "maximum distance" for this request.
Use this parameter to specify the number of similar articles you would like. The default value from the configuration is used if the parameter is not specified.
10Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.
This parameter is used to pass a user id for personalization across sessions. Required for Loop54 integrations.
OK
Bad Request
Unauthorized
Forbidden
Server Error
Required Roles: ApiImport Update or insert records; Without variants: inserts records when they do not already exist, or replaces them if they do. With Variants: inserts a master document when it does not exists; inserts a variant and replaces the master values if the variant does not exist; replaces a variant and replaces the master values if the variant does already exist.
The channel
falseThe records which should be upserted
OK
Bad Request
Unauthorized
Forbidden
Server Error
Last updated
Was this helpful?

