| Description | Query Sales Product Catalogues |
| Name | QuerySalesProductCatalogueIn |
| Namespace | http://sap.com/xi/AP/CatalogueAuthoring/Global |
| Process Component Description | Product Catalogue Authoring |
| Process Component Name | ProductCatalogueAuthoring |
| Process Component Namespace | http://sap.com/xi/AP/CatalogueAuthoring/Global |
| Deployment Unit Description | Catalogue Authoring |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to query sales product catalogue data.
The web service interface Query Sales Product Catalogue In enables you to connect external applications to your SAP Business ByDesign system and to query sales product catalogue data in your system.This service queries only published catalogues. This service is basically useful for e-commerce web shop integration scenarios.
This web service interface is relevant if external parties/system wants to access sales product catalogue data from external applications. This service provides information of published catalogues maintained in Product and Service Portfolio.
This web service interface offers the operations Find Catalogue And Items and Find Simple By Elements. This service can be used to first get list of all the available product catalogues by using Find Simple By Elements and then query details of individual product catalogue and its items by using Find Catalogue And Items.
Here is an example of the simple web service request:
Show full documentation
Show full documentation
<n0:SalesProductCatalogueQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<CatalogueAndItemSelection>
<CatalogueID>ABCD1234</CatalogueID>
<GrossPriceBasedCalculationRequiredIndicator>true</GrossPriceBasedCalculationRequiredIndicator>
</CatalogueAndItemSelection>
</n0:SalesProductCatalogueQuery_sync>
The above sample request queries product catalogue and item details of the catalogue with CatalogueID as ABCD1234 with gross price for the items.
<n0:SalesProductCatalogueByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<SelectionBySalesCatalogID>
<SelectionBySalesCatalogueID>
<InclusionExclusionCode>I</InclusionExclusionCode>
<IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
<LowerCatalogueID>ABCD1234</LowerCatalogueID>
<UpperCatalogueID/>
</SelectionBySalesCatalogueID>
</SelectionBySalesCatalogID>
<QueryProcessingConditions>
<QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
<LastReturnedObjectID></LastReturnedObjectID>
</QueryProcessingConditions>
</n0:SalesProductCatalogueByElementsQuery_sync>
The above sample request queries product catalogue name for the catalogue with CatalogueID as ABCD1234.
Existence of referenced business documents:
The following business documents are only queried and will not be created by the service operations:
Sales Catalogue
They must already exist in the system when the web service is called.
Query operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts.
The web service consumer (external application) is responsible for ensuring reasonable sizes for mass operations.
The structure of the query response message consists of three parts:
A business document specific part containing the returned business documents
Processing conditions
Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Possible Scenarios include the following:
Query Catalogue and Items
The FindCatalogueAndItems operation is used to query existing catalogue and item details.
Query Catalogue Name
The FindSimpleByElements operation is used to query existing catalogue names.
Here is an example web service request to query existing catalogue and item details:
<n0:SalesProductCatalogueQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<CatalogueAndItemSelection>
<CatalogueID>TestCatalog</CatalogueID>
<GrossPriceBasedCalculationRequiredIndicator>true</GrossPriceBasedCalculationRequiredIndicator>
</CatalogueAndItemSelection>
</n0:SalesProductCatalogueQuery_sync>
Here is an example web service request to query existing catalogue names:
<n0:SalesProductCatalogueByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<SelectionBySalesCatalogID>
<SelectionBySalesCatalogueID>
<InclusionExclusionCode>I</InclusionExclusionCode>
<IntervalBoundaryTypeCode>3</IntervalBoundaryTypeCode>
<LowerCatalogueID>ABCD1234</LowerCatalogueID>
<UpperCatalogueID>WXYZ6789</UpperCatalogueID>
</SelectionBySalesCatalogueID>
</SelectionBySalesCatalogID>
<QueryProcessingConditions>
<QueryHitsMaximumNumberValue>25</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator>
<LastReturnedObjectID></LastReturnedObjectID>
</QueryProcessingConditions>
</n0:SalesProductCatalogueByElementsQuery_sync>
| Description | Find sales product catalogues and items |
| Name | FindCatalogueAndItems |
| Synchronous | yes |
| Release Status | Released |
To find catalogue details such as name, sales area, item and section.
The request message of the operation FindCatalogueAndItems contains the CatalogueID and GrossPriceBasedCalculationRequiredIndicator nodes that gets catalogue details of published catalogues such as name, sales area, item and section.
This node is described in the following sub-chapter.
Note: This service does not support mass query and wild card search.
This node groups all selection parameters. The selection parameters are:
| Selection Parameter | Remark |
|---|---|
| CatalogueID | The ID of the Catalogue |
| GrossPriceBasedCalculationRequiredIndicator | Indicator for gross price based calculation. Setting this to true will get gross price of the catalogue. |
Note: If the price does not exists for any of the items then the response will contain all the requested items with log for each item which does not have price.
The response contains the catalogue and items in the catalogue.
Notes:
The service returns Net Price and Gross Price, but both are identical for historic reasons. Net/Gross only depends on the GrossPriceBasedCalculationRequiredIndicator in the request.
Currently, Multiple languages for Name and Description for a catalogue is not supported. Hence the maintained language will only be queried.
In this node, the catalogue, catalogue items and their data are contained according to the requested elements provided in the query request.
| Description | Find sales product catalogues |
| Name | FindSimpleByElements |
| Synchronous | yes |
| Release Status | Released |
To find catalogue details such as ID and name.
The request message of the operation FindSimpleByElements contains the InclusionExclusionCode, IntervalBoundaryTypeCode, LowerCatalogueID and UpperCatalogueID nodes that gets catalogue details of published catalogues such as ID and name. This node is described in the following sub-chapter.
This node groups all selection parameters. The selection parameters are:
SelectionBySalesCatalogueID
Query Processing Condition
For more information on "SelectionBySalesCatalogueID" (Selection Parameters) and "Query Processing Condition", refer generic A2X document.
The response contains the catalogue IDs and names of the catalogue. It is used to retrieve a list of sales product catalogue IDs and names.
In this node, the catalogue IDs and names of catalogues are contained according to the requested elements provided in the query request.