CyberStore Ecommerce 2023 Documentation
GetPrice
Returns the pricing for an Item in the CyberStore catalog for the user currently logged in.
The GetPrice operation has the following supported properties for posting queries:
Note:
Parameters surrounded by square brackets (e.g., [Quantity] ) are optional and do not have to be sent with the request.
|
Parameter |
Description |
|---|---|
|
ClientCode |
A unique value assigned to your application after it is registered within the CyberStore Console > CyberStore Connect maintenance screen. You must include this value in your request. |
|
SessionToken |
A unique value assigned by the CyberStore application to a user’s unique session. It is created after a successful login to the website via the CyberStore login screen. You must include this value in your request. Information about how to receive and capture the SessionToken is described in more detail later in this document. |
|
ClientSession_ID |
A unique identifier created by the application that runs on your registered client application. You need to capture it and send it with your request. CyberStore Connect utilizes this value, combined with the SessionToken and ClientCode, to validate the authenticity of the request. |
| StockCode |
The StockCode of the CyberStore Item to add. |
|
[Quantity] |
The quantity the requested price should be based upon.
When not submitted with the request, the default quantity is 1. |
|
[UOMType] |
The unit of measure the requested price should be based upon.
Values: “S” = Stocking, “A” = Alternate, “O” = Other.
When not submitted, the CyberStore relies on the "Preferred Unit of Measure" setting to determine which unit will be used. |
When you submit a request to the GetPrice operation, the response message is returned as an XML string. A query posted with the required, authenticated parameters returns results similar to the XML string below:
| Example GetPrice Query |
Copy Code
|
|---|---|
<?xml version="1.0" encoding="utf-8"?> <CyberStoreConnect> <Profile> <FirstName><![CDATA[Susan]]></FirstName> <LastName><![CDATA[Brown]]></LastName> <FullName><![CDATA[Susan Brown]]></FullName> <Username><![CDATA[sbrown@bikesblades.com]]></Username> <EmailAddress><![CDATA[sbrown@bikesblades.com]]></EmailAddress> <CustomerClass><![CDATA[Wholesaler]]></CustomerClass> <Customer><![CDATA[000002]]></Customer> <CustomerName><![CDATA[Bikes & Blades – North]]></CustomerName> <ViewList><![CDATA[Wholesaler View]]></ViewList> </Profile> <StockCode><![CDATA[A100]]></StockCode> <Quantity><![CDATA[10]]></Quantity> <ListPrice><![CDATA[$520.00]]></ListPrice> <UnitPrice><![CDATA[$440.00]]></UnitPrice> <UOM><![CDATA[EA]]></UOM> <TotalPrice><![CDATA[$4400.00]]</TotalPrice> <EventResponse> <Module>API</Module> <Severity>0</Severity> <Number>000</Number> <Message>Success!</Message> </EventResponse> </CyberStoreConnect> |
|
The XML string above contains the following elements:
|
Element |
Description |
|---|---|
|
Profile |
The information about the logged-in user’s session profile. See GetProfile for the complete definition of the Profile Results. |
|
StockCode |
The stock code of the Item. |
|
Quantity |
The quantity used to determine the price. |
|
ListPrice |
The List Price of the Item. |
|
UnitPrice |
The unit sales price for the Item. |
|
UOM |
The unit of measure for the Item. |
|
TotalPrice |
The total price of the Item (e.g., Quantity x Unit Price). |
|
EventResponse |
The details about the success or failure of the request including a module, severity, response number and message. A response number of ‘000’ with a message of “Success!” indicates that the request has been completed successfully. |
|
EventResponse/Module |
The CyberStore module that is responsible for the response. Typically, “API” is returned. |
|
EventResponse/Severity |
The severity of the response. Values = 0 to 9 |
|
EventResponse/Number |
The value that uniquely identifies the specific response.
|
|
EventResponse/Message |
The message returned by CyberStore that describes what occurred. |