Description | Query Product Categories |
Name | QueryProductCategories |
Namespace | http://sap.com/xi/A1S/Global |
Process Component Description | Product property management |
Process Component Name | ProductPropertyManagement |
Process Component Namespace | http://sap.com/xi/AP/FO/Product/Global |
Deployment Unit Description | Foundation |
Endpoint Activation | By Scoping of Process Component | Operations |
Release Status | Released |
An interface to query Product Category master data.
The web service interface Query Product Categories enables you to connect external applications to your solution and to query and read Product Categories and their details in your system. The web service interface is relevant if your company wants to access Product Categories from external applications.
Here is an example of a simple web service request, which seeks for all Product Category Hierarchies present in the system.
<n0:ProductCategoryHierarchy_SelectionByElements_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductCategoryHierarchySelectionByElements> <SelectionByInternalID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>10</LowerBoundaryIdentifier> </SelectionByInternalID> </ProductCategoryHierarchySelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> <RequestedElements productCategoryHierarchyTransmissionRequestCode="1"> <ProductCategoryHierarchy descriptionTransmissionRequestCode="1" productCategoryTransmissionRequestCode="1"/> </RequestedElements> </n0:ProductCategoryHierarchy_SelectionByElements_Sync>
Here is an excerpt of the response of the request above including one of the records returned by the query response:
<n0:ProductCategoryHierarchy_SelectionByElementResponse_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCL:/1SAI/TASD05EAE2DA9410339C09A:804"> <ProductCategoryHierarchy> <UUID>00300571-c924-02db-b8c5-a94f916c964b</UUID> <ID>BASE_PCH</ID> <Description> <Description languageCode="EN">Base</Description> </Description> <ProductCategoryHierarchyUsageCode>1</ProductCategoryHierarchyUsageCode> <SystemAdministrativeData> <CreationDateTime>2008-05-21T04:49:27.357107Z</CreationDateTime> <CreationIdentityUUID>00145ef5-88e6-02db-b8ad-62bc2e628346</CreationIdentityUUID> <LastChangeDateTime>2012-02-13T12:28:03.482102Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e01-107a-1def-a7c9-3961247ef358</LastChangeIdentityUUID> </SystemAdministrativeData> <ProductCategory> <ProductCategoryUUID>00145ef5-88e6-02ec-88da-b3ba2f6d4543</ProductCategoryUUID> <ProductCategoryInternalID>10</ProductCategoryInternalID> <ProductCategoryDescription> <Description languageCode="EN">Service</Description> </ProductCategoryDescription> <ParentInternalID>ROOT</ParentInternalID> <ProductAssignmentAllowedIndicator>true</ProductAssignmentAllowedIndicator> <ProductCategoryHierarchyUUID>00300571-c924-02db-b8c5-a94f916c964b</ProductCategoryHierarchyUUID> <ProductCategoryHierarchyID>BASE_PCH</ProductCategoryHierarchyID> </ProductCategory> </ProductCategoryHierarchy> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00300571C92402DBB8C5A94F916C964B</LastReturnedObjectID> </ProcessingConditions> </n0:ProductCategoryHierarchy_SelectionByElementResponse_Sync>
You can find general information about Web services, their structure and consumption in the Web Services documentation.
The following example scenario can be carried out using the requested elements.
Query request to get all cross process product categories with a description starting with āEā
<n0:ProductCategoryHierarchy_SelectionByElements_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductCategoryHierarchySelectionByElements> <SelectionByDescription> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryText>E*</LowerBoundaryText> </SelectionByDescription> <SelectionByUsageCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryCode>1</LowerBoundaryCode> </SelectionByUsageCode> </ProductCategoryHierarchySelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> <RequestedElements productCategoryHierarchyTransmissionRequestCode="1"> <ProductCategoryHierarchy descriptionTransmissionRequestCode="1" productCategoryTransmissionRequestCode="1"/> </RequestedElements> </n0:ProductCategoryHierarchy_SelectionByElements_Sync>
The product category hierarchy describes an hierarchical arrangement of product categories according to business aspect objective.
The product category hierarchy usage code (element ProductCategoryHierarchyUsageCode) represents the usage of a product category hierarchy, for example cross process, demand planning or production.
The query request above could for example return the following query response.
<n0:ProductCategoryHierarchy_SelectionByElementResponse_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCL:/1SAI/TASD05EAE2DA9410339C09A:804"> <ProductCategoryHierarchy> <UUID>00300571-c924-02db-b8c5-a94f916c964b</UUID> <ID>BASE_PCH</ID> <Description> <Description languageCode="EN">Base</Description> </Description> <ProductCategoryHierarchyUsageCode>1</ProductCategoryHierarchyUsageCode> <SystemAdministrativeData> <CreationDateTime>2008-05-21T04:49:27.357107Z</CreationDateTime> <CreationIdentityUUID>00145ef5-88e6-02db-b8ad-62bc2e628346</CreationIdentityUUID> <LastChangeDateTime>2012-02-13T12:28:03.482102Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e01-107a-1def-a7c9-3961247ef358</LastChangeIdentityUUID> </SystemAdministrativeData> <ProductCategory> <ProductCategoryUUID>00145ef5-88e6-02dc-88da-b44cd7a1854e</ProductCategoryUUID> <ProductCategoryInternalID>40-10-30</ProductCategoryInternalID> <ProductCategoryDescription> <Description languageCode="EN">Electronic furnaces</Description> </ProductCategoryDescription> <ParentInternalID>40-10</ParentInternalID> <ProductAssignmentAllowedIndicator>true</ProductAssignmentAllowedIndicator> <ProductCategoryHierarchyUUID>00300571-c924-02db-b8c5-a94f916c964b</ProductCategoryHierarchyUUID> <ProductCategoryHierarchyID>BASE_PCH</ProductCategoryHierarchyID> </ProductCategory> <ProductCategory> <ProductCategoryUUID>00145ef5-88e6-02ec-88da-b3c887948554</ProductCategoryUUID> <ProductCategoryInternalID>10-20</ProductCategoryInternalID> <ProductCategoryDescription> <Description languageCode="EN">Exhibition Stand Building</Description> </ProductCategoryDescription> <ParentInternalID>10</ParentInternalID> <ProductAssignmentAllowedIndicator>true</ProductAssignmentAllowedIndicator> <ProductCategoryHierarchyUUID>00300571-c924-02db-b8c5-a94f916c964b</ProductCategoryHierarchyUUID> <ProductCategoryHierarchyID>BASE_PCH</ProductCategoryHierarchyID> </ProductCategory> <ProductCategory> <ProductCategoryUUID>00145ef5-88e6-02ec-88da-b4dd1dd0c67f</ProductCategoryUUID> <ProductCategoryInternalID>60-10</ProductCategoryInternalID> <ProductCategoryDescription> <Description languageCode="EN">Electronic Parts</Description> </ProductCategoryDescription> <ParentInternalID>60</ParentInternalID> <ProductAssignmentAllowedIndicator>true</ProductAssignmentAllowedIndicator> <ProductCategoryHierarchyUUID>00300571-c924-02db-b8c5-a94f916c964b</ProductCategoryHierarchyUUID> <ProductCategoryHierarchyID>BASE_PCH</ProductCategoryHierarchyID> </ProductCategory> <ProductCategory> <ProductCategoryUUID>00145ef5-88e6-02ec-88da-b502ca99c6a7</ProductCategoryUUID> <ProductCategoryInternalID>60-20-30</ProductCategoryInternalID> <ProductCategoryDescription> <Description languageCode="EN">Electronic Burner</Description> </ProductCategoryDescription> <ParentInternalID>60-20</ParentInternalID> <ProductAssignmentAllowedIndicator>true</ProductAssignmentAllowedIndicator> <ProductCategoryHierarchyUUID>00300571-c924-02db-b8c5-a94f916c964b</ProductCategoryHierarchyUUID> <ProductCategoryHierarchyID>BASE_PCH</ProductCategoryHierarchyID> </ProductCategory> <ProductCategory> <ProductCategoryUUID>00145ef5-88e6-02ec-88da-b52f1036c6cf</ProductCategoryUUID> <ProductCategoryInternalID>70-20</ProductCategoryInternalID> <ProductCategoryDescription> <Description languageCode="EN">Equipment</Description> </ProductCategoryDescription> <ParentInternalID>70</ParentInternalID> <ProductAssignmentAllowedIndicator>true</ProductAssignmentAllowedIndicator> <ProductCategoryHierarchyUUID>00300571-c924-02db-b8c5-a94f916c964b</ProductCategoryHierarchyUUID> <ProductCategoryHierarchyID>BASE_PCH</ProductCategoryHierarchyID> </ProductCategory> <ProductCategory> <ProductCategoryUUID>00145ef5-88e6-02ec-88da-b55feeeac6ff</ProductCategoryUUID> <ProductCategoryInternalID>310-20</ProductCategoryInternalID> <ProductCategoryDescription> <Description languageCode="EN">Exhibition Stand Building</Description> </ProductCategoryDescription> <ParentInternalID>310</ParentInternalID> <ProductAssignmentAllowedIndicator>true</ProductAssignmentAllowedIndicator> <ProductCategoryHierarchyUUID>00300571-c924-02db-b8c5-a94f916c964b</ProductCategoryHierarchyUUID> <ProductCategoryHierarchyID>BASE_PCH</ProductCategoryHierarchyID> </ProductCategory> <ProductCategory> <ProductCategoryUUID>00145ef5-88e6-02ec-88da-b61ef047c7b8</ProductCategoryUUID> <ProductCategoryInternalID>360-30</ProductCategoryInternalID> <ProductCategoryDescription> <Description languageCode="EN">Equipment</Description> </ProductCategoryDescription> <ParentInternalID>360</ParentInternalID> <ProductAssignmentAllowedIndicator>true</ProductAssignmentAllowedIndicator> <ProductCategoryHierarchyUUID>00300571-c924-02db-b8c5-a94f916c964b</ProductCategoryHierarchyUUID> <ProductCategoryHierarchyID>BASE_PCH</ProductCategoryHierarchyID> </ProductCategory> </ProductCategoryHierarchy> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00300571C92402DBB8C5A94F916C964B</LastReturnedObjectID> </ProcessingConditions> </n0:ProductCategoryHierarchy_SelectionByElementResponse_Sync>
Description | Find product categories |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
No documentation available.