PriceList noun is used to model a price list.
A price list contains multiple price list entries (offers).
It can be made available to all customers, or to only customers in certain groups through the trading agreements or contracts,
and the terms and conditions in the contracts. Under a contract, a price list is a price business object that can be referenced
by multiple price business policies and can be shared by a store or all stores in a store group. A trading position container
is also referred to as a price list. In some business models, you may have multiple standard price lists, which could be based
on either cost, or on list prices.
| BOD | Action Code / Access Profile | Action Expression | Service Provided | Sample XML Message | Client Library / Expression Builder |
|---|---|---|---|---|---|
| GetPriceList | IBM_PriceListSummaryProfile | /PriceList/PriceListIdentifier[UniqueID=] | Get the information of a price list according to unique ID of the price list. |
Request
Response |
PriceFacadeClient.findPriceListById(String) |
| IBM_PriceListSummaryProfile | /PriceList/PriceListIdentifier/ExternalIdentifier[(Name=) and StoreIdentifier[UniqueID=]] | Get the information of a price list according to name of the price list and store id. |
Request
Response |
PriceFacadeClient.getPriceList(com.ibm.commerce.oagis9.datatypes.GetType) | |
| IBM_PriceEntryDetailProfile IBM_PriceEntryBaseProfile | /PriceList[PriceListIdentifier[UniqueID=] and PriceEntry[Qualifier= and CatalogEntryIdentifier[UniqueID=]]] | Get the information of a price entry (offer) according to the unique ID of the price list, and the catalog ID and the qualifier of the price entry. |
Request
Response |
PriceFacadeClient.findPriceEntryByPriceListIdAndQualifierAndCatentryId(String, String, String) | |
| IBM_PriceEntryDetailProfile IBM_PriceEntryBaseProfile | /PriceList/PriceEntry[Qualifier= and CatalogEntryIdentifier[UniqueID=]] | Get the information of a price entry according to the catalog ID and the qualifier of the price entry. |
Request
Response |
PriceFacadeClient.findPriceEntryByQualifierAndCatEntryId(String, String) | |
| IBM_PriceEntryDetailProfile IBM_PriceEntryBaseProfile | /PriceList/PriceEntry/CatalogEntryIdentifier[UniqueID=] | Get the information of a price entry according to the catalog ID of the price entry. |
Request
Response |
PriceFacadeClient.findPriceEntryByCatentryId(String) | |
| IBM_Store_PriceEntry_Details |
{_wcf.ap=IBM_Store_PriceEntry_Details;_wcf.dataRetrieval='outboundOnly'}/PriceList[PriceEntry[(CatalogEntryIdentifier[ExternalIdentifier[PartNumber=]]
and Price[(Quantity= and Quantity[@uom=]) and Price[@currency=]])]]
{_wcf.ap=IBM_Store_PriceEntry_Details;_wcf.dataRetrieval='localOnly'}/PriceList[PriceEntry[(CatalogEntryIdentifier[ExternalIdentifier[PartNumber=]] and Price[(Quantity= and Quantity[@uom=]) and Price[@currency=]])]] {_wcf.ap=IBM_Store_PriceEntry_Details;_wcf.dataRetrieval='localThenOutbound'}/PriceList[PriceEntry[(CatalogEntryIdentifier[ExternalIdentifier[PartNumber=]] and Price[(Quantity= and Quantity[@uom=]) and Price[@currency=]])]] |
Get the entitled price detail information for a shopper according to the partnumber, quantity, UOM and currency. |
Request
Response |
PriceFacadeClient.getPriceList(GetPriceListType) | |
| IBM_PriceListDetailProfile | /PriceList/PriceListIdentifier/ExternalIdentifier/StoreIdentifier[UniqueID=] | Find all price lists in store with detail information. |
Request
Response |
PriceFacadeClient.getPriceList(com.ibm.commerce.oagis9.datatypes.GetType) | |
| IBM_PriceListDetailProfile | /PriceList/PriceListIdentifier/ExternalIdentifier[(Name=) and StoreIdentifier[UniqueID=]] | Find price lists in store by name with detail information. |
Request
Response |
PriceFacadeClient.getPriceList(com.ibm.commerce.oagis9.datatypes.GetType) | |
| ProcessPriceList | Create | /PriceList[i] | Create price list. |
Request
Response |
PriceFacadeClient.processPriceList(ProcessPriceListType) |
| Delete | /PriceList[i] | Delete price list. |
Request
Response |
PriceFacadeClient.processPriceList(ProcessPriceListType) | |
| ChangePriceList | Change | /PriceList[i] | Change price list attributes. |
Request
Response |
PriceFacadeClient.changePriceList(ChangePriceListType) |
| Add | /PriceList[]/PriceEntry[] | Create a new price entry in the price list. |
Request
Response |
PriceFacadeClient.addPriceEntry(PriceListType) | |
| Change | /PriceList[]/PriceEntry[] | Update an existing price entry in a price list. |
Request
Response |
PriceFacadeClient.changePriceEntry(PriceListType) | |
| Change | /PriceList[]/PriceEntry[]/Price | Update the unit price of an existing price entry in a price list. |
Request
Response |
PriceFacadeClient.changePriceEntryPrice(PriceListType) | |
| Change | /PriceList[]/PriceEntry[]/Price/AlternativeCurrencyPrice[] | Update an unit price in alternative currency of an existing price entry in a price list. |
Request
Response |
PriceFacadeClient.changePriceEntryAlternativePrice(PriceListType) | |
| Delete | /PriceList[]/PriceEntry[] | Delete a price entry in a price list. |
Request
Response |
PriceFacadeClient.deletePriceEntry(PriceListType) | |
| Delete | /PriceList[]/PriceEntry[]/Price/AlternativeCurrencyPrice[] | Delete an unit price in alternative currency in a price entry in a price list. |
Request
Response |
PriceFacadeClient.deletePriceEntryAlternativePrice(PriceListType) |
Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.
| Access Profile | Data Returned |
|---|---|
| IBM_PriceListSummaryProfile |
|
| IBM_PriceEntryDetailProfile |
|
| IBM_PriceEntryBaseProfile |
|
| IBM_Store_PriceEntry_Details |
|
| IBM_PriceListDetailProfile |