DCi Data API
Lookup API
Description
StockChek is used to retrieve WD and Manufacturer stock information
Manufacturer StockChek
Returns Availability of a part from the manufacturer and manufacturer contact information
Endpoint
/API/StockChek/MFGStockChek
Parameters
authkey
requiredThe key to authenticate to the API
Example: 00000000-0000-0000-0000-000000000000
Source: The key provided for your account
partnumber
requiredthe part identifier assigned by the manufacturer
Example: EX4110-T
Source: | A valid value from Get Catalog Parts field API.Part |
A valid value from Get Part List field API.PartList.PartItems.PartNumber |
linecode
The three character DCi code for a catalog (brand)
Example: ACL
Source: A valid value from Get Catalogs field Catalog.Linecode
aaia
The four character AAIA code for a catalog (brand)
Example: BDDP
Source: A valid value from Get Catalogs field Catalog.AAIA
format
The format in which the response will be returned
Default Value: JSON
Valid Values: JSON, XML
Example Response
{ "StockChek": { "MFGStockChek": [ { "Name": "Manufacturer Name", "City": "Des Moines", "State": "IA", "Country": "United States", "CountryAbbr": "US", "PhoneNumber": "(515)555-6356", "Availability": "Available", "Email": "support@dcinet.com" } ], "Status": { "Message": "The call (api.v12.estore.catalograck.com) returned successfully with mfgstockchecks.", "DataFound": true, "TimeStamp": "05/18/2021 08:48:59", "InternalError": false } } }
Response Fields
StockChek
objectThe container for the response
StockChek.MFGStockChek
objectThe StockChek information for the queried part
StockChek.MFGStockChek.Name
stringThe name of the manufacturer
StockChek.MFGStockChek.City
stringThe city in which the manufacturer is located
StockChek.MFGStockChek.State
stringThe state in which the manufacturer is located
StockChek.MFGStockChek.Country
stringThe country in which the manufacturer is located
StockChek.MFGStockChek.CountryAbbr
stringThe abbreviation for the country in which the manufacturer is located
StockChek.MFGStockChek.PhoneNumber
stringThe phone number for the manufacturer
StockChek.MFGStockChek.Email
stringThe email address for the manufacturer
API.Status
objectInformation on the state of the response
API.Status.Message
stringA success message or cause of a failed call
API.Status.DataFound
booleanWhether or not data was found for the request
API.Status.TimeStamp
datetimeThe date and time of the request
API.Status.InternalError
booleanWhether or not there was an internal error while processing the request
Try it with your Data
Enter your authentication key at the top to try
Warehouse Distributor StockChek
Returns Availability of a part from the distributor and distributor information
Endpoint
/API/StockChek/WDStockChek
Parameters
authkey
requiredThe key to authenticate to the API
Example: 00000000-0000-0000-0000-000000000000
Source: The key provided for your account
partnumber
requiredthe part identifier assigned by the manufacturer
Example: EX4110-T
Source: | A valid value from Get Catalog Parts field API.Part |
A valid value from Get Part List field API.PartList.PartItems.PartNumber |
linecode
The three character DCi code for a catalog (brand)
Example: ACL
Source: A valid value from Get Catalogs field Catalog.Linecode
aaia
The four character AAIA code for a catalog (brand)
Example: BDDP
Source: A valid value from Get Catalogs field Catalog.AAIA
format
The format in which the response will be returned
Default Value: JSON
Valid Values: JSON, XML
Example Response
{ "StockChek": { "WDStockChek": [ { "Name": "Generic Distributing", "City": "Des Moines", "State": "IA", "Country": "United States", "CountryAbbr": "US", "PhoneNumber": "(515)555-2325", "Availability": "Out of Stock - Call to special Order", "Email": "support@dcinet.com" } ], "Status": { "Message": "The call (api.v12.estore.catalograck.com) returned successfully with wdstockchecks.", "DataFound": true, "TimeStamp": "05/18/2021 09:36:08", "InternalError": false } } }
Response Fields
StockChek
objectThe container for the response
StockChek.WDStockChek
objectThe StockChek information for the queried part
StockChek.WDStockChek.Name
stringThe name of the distributor
StockChek.WDStockChek.City
stringThe city in which the distributor warehouse is located
StockChek.WDStockChek.State
stringThe state in which the distributor warehouse is located
StockChek.WDStockChek.Country
stringThe country in which the distributor warehouse is located
StockChek.WDStockChek.CountryAbbr
stringThe abbreviation for the country in which the distributor warehouse is located
StockChek.WDStockChek.PhoneNumber
stringThe phone number for the distributor
StockChek.WDStockChek.Availability
stringThe availability of the part
StockChek.WDStockChek.Email
stringThe email address for the distributor
API.Status
objectInformation on the state of the response
API.Status.Message
stringA success message or cause of a failed call
API.Status.DataFound
booleanWhether or not data was found for the request
API.Status.TimeStamp
datetimeThe date and time of the request
API.Status.InternalError
booleanWhether or not there was an internal error while processing the request
Try it with your Data
Enter your authentication key at the top to try