WSElectronicOrder
This suite of web service methods provides the ability to Check Inventory, Get Shipping Options, and Place Orders.
The following operations are supported. For a formal definition, please review the Service Description.
-
CheckInventory
This web service method returns the current inventory counts in all stocking warehouses available to the customer (in a string).
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - This is the 5-7 character account number provided by Keystone.
FullPartNo (String) - This is the full part number of the product. The full part number includes the Keystone vendor line code and the Keystone part number.
Output - A single string return value: The warehouse and inventory information as paired comma separated values. For example: 'EAST,5,MIDWEST,1'
Please see the supporting documentation for a list of other variations of output. -
CheckInventoryBulk
This web service method returns the current inventory counts in all stocking warehouses available to the customer (in a dataset).
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - The 5-7 character account number provided by Keystone.
FullPartNo (String) - The full part number, which includes the Keystone vendor line code and the Keystone part number. If multiple parts are entered, please separate each value with a comma.
Output - Returns an XML document with the following schema: PartNumber, Warehouse/Quantity, Blocked, SupersededFrom, ErrorMessage
Please see the supporting documentation for a list of other variations of output. -
CheckPriceBulk
This web service method returns the price of a part by VCPN to a customer (in a string).
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - This is the 5-7 character account number provided by Keystone.
FullPartNo (String) - The full part number, which includes the Keystone vendor line code and the Keystone part number. If multiple parts are entered, please separate each value with a comma.
Output - Returns an XML document with the following schema: Vendor, PartNumber, CustomerPrice, Currency
Please see the supporting documentation for a list of other variations of output. -
ClearBasket
DEPRECATED -
GetImagePartInformation
This web service method provides product image information.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - Full 5-7 character account number provided by Keystone.
PartNumbers (String) - A comma separated list of full part numbers, which includes the Keystone vendor line code and the Keystone part number. A maximum of 10 parts is allowed per call.
ImageSize (String) - The size of the image to be returned: 'ThumbNail' (Default), 'Small', 'Medium', or 'Large'.
Output - Returns a dataset containing the following: VCPN (FullPartNumber), Message, ImageLocationURL, MediaTypeName, Representation.
____ MediaTypeName may be 'Image' or an empty string.
____ Representation may be 'Actual' for actual image, 'Representation' for not actual image, and 'None' for no image found. -
GetInventoryFull
This web service method provides the customer with inventory counts of stocking items.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - Full 5-7 character account number provided by Keystone.
Output - A dataset containing several fields, including: VCPN, VendorCode, PartNumber, and item quantities available across all Keystone warehouses.
NOTE: This method may be called only once per day. -
GetInventoryQuantityFull
This web service method provides the customer with inventory counts of stocking items.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - Full 5-7 character account number provided by Keystone.
Output - A dataset containing several fields, including: VCPN, VendorCode, PartNumber, and TotalQty (available in total from all warehouses).
NOTE: This method may be called only once per day. -
GetInventoryQuantityUpdates
This web service method provides the customer with total inventory count updates.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - Full 5-7 character account number provided by Keystone.
Output - A dataset containing several fields, including: VCPN, VendorCode, PartNumber, and TotalQty (available in total from all warehouses).
NOTE: This method may be called only once every 15 minutes. -
GetInventoryUpdates
This web service method provides the customer with inventory count updates by warehouse.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - Full 5-7 character account number provided by Keystone.
Output - A dataset containing several fields, including: VCPN, VendorCode, PartNumber, and item quantities available across all Keystone warehouses.
NOTE: This method may be called only once every 15 minutes. -
GetKitComponents
This web service method accepts a kit part number and returns the kits components and component quantity (in a dataset).
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - The 5-7 character account number provided by Keystone.
FullKitPartNumber (String) - The full part number, which includes the Keystone vendor line code and the Keystone part number.
Output - Returns an XML document with the following schema: PartNumber, Component Quantity
Please see the supporting documentation for a list of other variations of output. -
GetOrderHistory
This web service method allows the user to check order history. It returns a dataset containing real-time status on orders placed.
Input Values:
Key - Web service security key assigned by Keystone.
FullAccountNo - The 5-7 character account number provided by Keystone.
PONumber - The PONumber in question (this is an optional parameter).
FromDate - The date in which to start searching for order history. Must be in YYYYMMDD format.
ToDate - The date in which to stop searching for order history. Must be in YYYYMMDD format.
You may pass a PO Number, a range of dates, or both. Passing all three parameters
will cause the function to search for the PO within the range of dates specified (most efficient).
If no dates are specified, the entire available history will be searched. If only a date range is
passed, then all history from within that date range will be returned.
If there is no data available for your query, the field EKORD# will contain the 'NoData'.
If you pass bad data to the web method, the field EKORD# will contain 'BadInDt'.
Note: Using a date range of more than 30 days may cause a timeout because of the volume
of data. Please limit the range to 120 days.
Return Values:
EKCCUS - Customer Number - 7 Char
EKORD# - PO Number - 20 Char
EKDATE - Date Ordered - 8 Char (YYYYMMDD)
EKTIME - Time Ordered - 6 Char (HHMMSS) - if length is shorter than 6, zeros should be padded to the left)
EKVEND - Vendor Code - 3 Char
EKPART - Part Number - 20 Char
EKXQTY - Quantity - 5 Char
EKEXTD - Extended Price - 11 Char, 2 decimal places
EKFRTD - Freight Charge - 9 Char, 2 decimal places
EKSWHS - Ship Warehouse - 2 Char:
____ Whse 1 = Exeter, Pennsylvania (EAST)
____ Whse 14 = Kansas City, Kansas (MIDWEST)
____ Whse 25 = Eastvale, California (CALIFORNIA)
____ Whse 30 = Atlanta, Georgia (SOUTHEAST)
____ Whse 45 = Spokane, Washington (PACIFIC NORTHWEST)
____ Whse 50 = Flower Mound, Texas (TEXAS)
____ Whse 60 = Brownstown, Michigan (GREAT LAKES)
____ Whse 70 = Orlando, Florida (FLORIDA)
EKSVIA - Ship Method Code - 1 Char (6 = Keystone Truck Run, 2 = Fedex, 3 = UPS)
EKTRCK - Tracking Number - 30 Char
EKSTAT - Status Code - 7 Char
____ 3rd party shipping method values: RCV ORD, ORDER, PICK, PACKAGE, INVOICE, CANCEL
____ Keystone Truck Run method values: RCV ORD, ORDER, PICK, XDOCK, OUT4DLV, INVOICE, CANCEL
EKPRIC - Unit Price - 9 Char, 2 decimal places
EKKEY# - Keystone internal order number - 7 Char
EKINV# - Invoice Number - 11 Char, 0 decimal places -
GetOrderHistoryByParentAccount
This web service method allows the user to check order history for child accounts. It returns a dataset containing a data table of information, along with a data table of real-time status on orders placed.
Input Values:
Key - Web service security key assigned by Keystone.
ParentAccountNo - The 5-7 character PARENT account number provided by Keystone.
PONumbers - The PONumbers in question. PLEASE see supporting documentation for more information.
FromDate - The date in which to start searching for order history. Must be in YYYYMMDD format.
ToDate - The date in which to stop searching for order history. Must be in YYYYMMDD format.
ChildAccountNumbers - A list of child account numbers used to narrow the search. PLEASE see supporting documentation for more information. -
GetShippingOptions
This web service method returns a list of shipping service level options based on the warehouses accessible to the customer, the availability of the part, and the postal code specified. PLEASE NOTE: This web method assumes that a quantity of ONE part is being ordered.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - The 5-7 character account number provided by Keystone.
FullPartNo (String) - The full part number includes the Keystone vendor line code and the Keystone part number.
ToZip (String) - Zip code the item is to be shipped to. Note: If no zip code is passed in, the customer's default zip code will be used.
Quantity (Integer) - The quantity of parts to be ordered.
Output - Returns an XML document with the following schema:
____ ServiceLevel - the Keystone shipping service level code
____ Name - a friendly name of the shipping method
____ Rate - the quoted shipping rate for the shipping method
____ Warehouses - Lists the quantity of the full part number specified that will be shipped from each location
____ Backordered - Quantity backordered
____ Cancelled - Quantity cancelled
____ AdditionalFees - Any additional fees. -
GetShippingOptionsMultipleParts
This web service method returns a list of shipping service level options available based on the warehouses accessible to the customer, the availability of the part, and the postal code specified.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - Full 5-7 character account number provided by Keystone.
PartNumber/Quantity CSV, Pipe separated (String) - Full part number and Quantity separated by a comma.
____ Please use the following format: SearchType,PartNumber,Quantity|(Pipe Seperator)SearchType,PartNumber,Quantity
____ S,XXXYYYYYY,2|S,AAABBBBB,1|S,NNNMMMMMMM,3
____ SearchTypes are as follows: N - NTP Product Number | U - UPC Code | K - VCPN
ToZip (String) - Zip code item is to be shipped to. Note: if no zip code is passed in, the customers account default zip code will be used.
Output - Returns an XML document with the following schema:
____ ServiceLevel - the Keystone shipping service level code
____ Name - a friendly name of the shipping method
____ Rate - the quoted shipping rate for the shipping method
____ Warehouses - Lists the quantity of the full part number specified that will be shipped from each location.
____ Backordered - Quantity backordered
____ Cancelled - Quantity cancelled
____ Additional Fee - Any additional fees. -
GetShippingOptionsMultiplePartsPerWarehouse
This web service method returns a list of shipping service level options available based on the warehouses accessible to the customer, the availability of the part, and the postal code specified.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - Full 5-7 character account number provided by Keystone.
PartNumber/Quantity CSV, Pipe separated (String) - Full part number and Quantity separated by a comma.
____ Please use the following format: SearchType,PartNumber,Quantity|(Pipe Seperator)SearchType,PartNumber,Quantity
____ S,XXXYYYYYY,2|S,AAABBBBB,1|S,NNNMMMMMMM,3
____ SearchTypes are as follows: N - NTP Product Number | U - UPC Code | K - VCPN
ToZip (String) - Zip code item is to be shipped to. Note: if no zip code is passed in, the customers account default zip code will be used.
Output - Returns a dataset including three or more data tables:
____ PartsData (data passed into the method, indicating the status of each part ordered)
____ PartsQuantityPerWarehouse (lists the Vendor Name, Part Number, the warehouse the part would be shipped from, a status indicating whether or not the part will ship, and the quantity of product that will be shipped)
____ Warehouse_[WarehouseName]_[WarehouseNumber] (this contains all shipping options, and the total freight charge for each method, for the parts shipping from this warehouse) -
GetShippingOptionsMultiplePartsPerWarehouseC2M
This web service method returns a list of shipping service level options available based on the warehouses accessible to the customer, the availability of the part, and the postal code specified.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - Full 5-7 character account number provided by Keystone.
PartNumber/Quantity CSV, Pipe separated (String) - Full part number and Quantity separated by a comma.
____ Please use the following format: SearchType,PartNumber,Quantity|(Pipe Seperator)SearchType,PartNumber,Quantity
____ S,XXXYYYYYY,2|S,AAABBBBB,1|S,NNNMMMMMMM,3
____ SearchTypes are as follows: N - NTP Product Number | U - UPC Code | K - VCPN
ToZip (String) - Zip code item is to be shipped to. Note: if no zip code is passed in, the customers account default zip code will be used.
Output - Returns a dataset including three or more data tables:
____ PartsData (data passed into the method)
____ PartsQuantityPerWarehouse
____ Warehouse_[WarehouseName]_[WarehouseNumber] (this contains all shipping options, and the total freight charge for each method, for the parts shipping from this warehouse.) -
GetShippingOptionsWithQuantity
This web service method returns a list of shipping service level options based on the warehouses accessible to the customer, the availability of the part, and the postal code specified.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - The 5-7 character account number provided by Keystone.
FullPartNo (String) - The full part number includes the Keystone vendor code and Keystone part number.
ToZip (String) - Zip code the item is to be shipped to. Note: If no zip code is passed in, the customer's default zip code will be used.
Quantity (Integer) - The quantity of parts to be ordered.
Output - Returns an XML document with the following schema:
____ ServiceLevel - the Keystone shipping service level code
____ Name - a friendly name of the shipping method
____ Rate - the quoted shipping rate for the shipping method
____ Warehouses - Lists the quantity of the full part number specified that will be shipped from each location
____ Backordered - Quantity backordered
____ Cancelled - Quantity cancelled
____ Additional Fee - Any additional fees. -
PlaceOrder
DEPRECATED -
PlaceOrderDropShip
DEPRECATED -
ShipOrder
This web service method creates and places an order based on the information passed in. It returns a real-time status on the line item. This method does not accept a "ship to" address. All orders can be viewed through eKeystone or the GetOrderHistory web method.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - The 5-7 character account number provided by Keystone.
FullPartNo (String) - This is the full part number of the product to order. The full part number includes the Keystone vendor line code and the Keystone part number.
Quant (String) - The quantity of the part to be ordered.
PONumber (String) - PO Number for this line item (20 char max).
AdditionalInfo (String) - Information pertaining to this item that the user would like to include.
ServiceLevel (String) - The shipping method for this item. This can be found through the GetShippingOptions web method.
Output - A single string return value: an "Order Placed" confirmation, or error message. -
ShipOrderDropShip
This web service method creates and places an order based on the information passed in. It returns a real-time status on the line item. This method is very similar to ShipOrder, however, it breaks up the "ship to" fields into separate parameters. It allows different shipping options, available through the GetShippingOptions method. All orders can be viewed through eKeystone or the GetOrderHistory web method.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - The 5-7 character account number provided by Keystone.
FullPartNo (String) - The full part number includes the Keystone vendor line code and the Keystone part number.
Quantity (String) - The quantity of the part to be ordered.
DropShipFirstName (String) 25 char - Drop ship customer’s first name.
DropShipMiddleInitial (String) 1 char - Drop ship customer’s middle initial.
DropShipLastName (String) 25 char - Drop ship customer’s last name.
DropShipAddress1 (String) 35 char - Drop ship customer’s address line 1.
DropShipAddress2 (String) 35 char - Drop ship customer’s address line 2.
DropShipCity (String) 30 char - Drop ship customer’s city.
DropShipState (String) 2 char - Drop ship customer’s state.
DropShipPostalCode (String) 12 char - Drop ship customer’s postal code.
DropShipPhone (String) 15 char - Drop ship customer’s phone - use format: XXX-XXX-XXXX
DropShipState (String) 2 char - Drop ship customer’s state.
DropShipCountry (String) 3 char - Drop ship customer’s country
DropShipEmail (String) 255 char - Drop ship customer’s email.
PONumber (String) 20 char - The PO number for this line item.
AdditionalInfo (String) 255 char - Information pertaining to this item that the user would like to include.
ServiceLevel (String) 3 char - The shipping method for this item. This can be found through the GetShippingOptions web method.
Output - A single string return value: an "OK" confirmation, or error message -
ShipOrderDropShipMultipleParts
This web service method creates and places an order based on the information passed in. It returns a real-time status on the line item(s). This method is very similar to ShipOrderDropShip, however, it accepts multiple line items per order. It allows different shipping options, available through the GetShippingOptions method. All orders can be viewed through eKeystone or the GetOrderHistory web method.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - The 5-7 character account number provided by Keystone.
OrderProcessMethod (Integer) - What to do with the order:
____ 0 - Verify Order - No parts are ordered; this assures the user that the order can be fulfilled by Keystone.
____ 1 - Complete order - All parts are ordered if zero 'X' records are returned; ORDER FAILS IF THERE IS ONE OR MORE 'X' RECORDS.
PartNumberQuantity (String) - Partnumber (the Keystone vendor line code and the Keystone part number) and quantity. The string is in the following format:
____ 'K33332206,1|G12100,1,Special Deal' - a comma seperates the part number from the quantity and Additional Part Information (OPTIONAL).
____ A pipe '|' seperates the full part number and quantity from additional part number/quantity groups.
____ A maximum of 250 partnumber/quantity groupings is allowed.
DropShipFirstName (String) 25 char - Drop ship customer’s first name.
DropShipMiddleInitial (String) 1 char - Drop ship customer’s middle initial.
DropShipLastName (String) 25 char - Drop ship customer’s last name.
DropShipAddress1 (String) 35 char - Drop ship customer’s address line 1.
DropShipAddress2 (String) 35 char - Drop ship customer’s address line 2.
DropShipCity (String) 30 char - Drop ship customer’s city.
DropShipState (String) 2 char - Drop ship customer’s state.
DropShipPostalCode (String) 12 char - Drop ship customer’s postal code.
DropShipPhone (String) 15 char - Drop ship customer’s phone - use format: XXX-XXX-XXXX
DropShipState (String) 2 char - Drop ship customer’s state.
DropShipCountry (String) 3 char - Drop ship customer’s country
DropShipEmail (String) 255 char - Drop ship customer’s email.
PONumber (String) 20 char - The PO number for this order's line items.
AdditionalInfo (String) 255 char - NOT CURRENTLY IMPLEMENTED, use PartNumberQuantity to pass additional info by part.
ServiceLevel (String) 3 char - The shipping method for this item. This can be found through the GetShippingOptions web method.
Output - A dataset with two tables, 'Status' and 'PartResults'.
The Status table contains one row. Possible outputs are: "OK", "Verified" or "Error: " + error message.
The PartResults table contains a list of the input parts, quantity, status and statusmessage.
The 'Status' column value of the PartResults table will be ' ' or 'X'. 'X' is a non orderable item; the 'StatusMessage' column will display the reason for which the order was rejected. -
ShipOrderSpecialOrderMultipleParts
This web service method is a duplicate of ShipOrderDropShipMultipleParts that does only Special Orders and doesn't include kits. It creates and places an order based on the information passed in. It returns a real-time status on the line item(s). This method is very similar to ShipOrderDropShip, however, it accepts multiple line items per order. It allows different shipping options, available through the GetShippingOptions method. All orders can be viewed through eKeystone or the GetOrderHistory web method.
Input Values:
Key (String) - Web service security key assigned by Keystone.
FullAccountNo (String) - The 5-7 character account number provided by Keystone.
OrderProcessMethod (Integer) - What to do with the order:
____ 0 - Verify Order - No parts are ordered; this assures the user that the order can be fulfilled by Keystone.
____ 1 - Complete order - All parts are ordered if zero 'X' records are returned; ORDER FAILS IF THERE IS ONE OR MORE 'X' RECORDS.
PartNumberQuantity (String) - Partnumber (the Keystone vendor line code and the Keystone part number) and quantity. The string is in the following format:
____ 'K33332206,1|G12100,1,Special Deal' - a comma seperates the part number from the quantity and Additional Part Information (OPTIONAL).
____ A pipe '|' seperates the full part number and quantity from additional part number/quantity groups.
____ A maximum of 250 partnumber/quantity groupings is allowed.
DropShipFirstName (String) 25 char - Drop ship customer’s first name.
DropShipMiddleInitial (String) 1 char - Drop ship customer’s middle initial.
DropShipLastName (String) 25 char - Drop ship customer’s last name.
DropShipAddress1 (String) 35 char - Drop ship customer’s address line 1.
DropShipAddress2 (String) 35 char - Drop ship customer’s address line 2.
DropShipCity (String) 30 char - Drop ship customer’s city.
DropShipState (String) 2 char - Drop ship customer’s state.
DropShipPostalCode (String) 12 char - Drop ship customer’s postal code.
DropShipPhone (String) 15 char - Drop ship customer’s phone - use format: XXX-XXX-XXXX
DropShipState (String) 2 char - Drop ship customer’s state.
DropShipCountry (String) 3 char - Drop ship customer’s country
DropShipEmail (String) 255 char - Drop ship customer’s email.
PONumber (String) 20 char - The PO number for this order's line items.
AdditionalInfo (String) 255 char - NOT CURRENTLY IMPLEMENTED, use PartNumberQuantity to pass additional info by part.
ServiceLevel (String) 3 char - The shipping method for this item. This can be found through the GetShippingOptions web method.
Output - A dataset with two tables, 'Status' and 'PartResults'.
The Status table contains one row. Possible outputs are: "OK", "Verified" or "Error: " + error message.
The PartResults table contains a list of the input parts, quantity, status and statusmessage.
The 'Status' column value of the PartResults table will be ' ' or 'X'. 'X' is a non orderable item; the 'StatusMessage' column will display the reason for which the order was rejected.