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
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

partnumber
required

the 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

object

The container for the response

StockChek.MFGStockChek

object

The StockChek information for the queried part

StockChek.MFGStockChek.Name

string

The name of the manufacturer

StockChek.MFGStockChek.City

string

The city in which the manufacturer is located

StockChek.MFGStockChek.State

string

The state in which the manufacturer is located

StockChek.MFGStockChek.Country

string

The country in which the manufacturer is located

StockChek.MFGStockChek.CountryAbbr

string

The abbreviation for the country in which the manufacturer is located

StockChek.MFGStockChek.PhoneNumber

string

The phone number for the manufacturer

StockChek.MFGStockChek.Email

string

The email address for the manufacturer

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether 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
required

The key to authenticate to the API

Example: 00000000-0000-0000-0000-000000000000

Source: The key provided for your account

partnumber
required

the 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

object

The container for the response

StockChek.WDStockChek

object

The StockChek information for the queried part

StockChek.WDStockChek.Name

string

The name of the distributor

StockChek.WDStockChek.City

string

The city in which the distributor warehouse is located

StockChek.WDStockChek.State

string

The state in which the distributor warehouse is located

StockChek.WDStockChek.Country

string

The country in which the distributor warehouse is located

StockChek.WDStockChek.CountryAbbr

string

The abbreviation for the country in which the distributor warehouse is located

StockChek.WDStockChek.PhoneNumber

string

The phone number for the distributor

StockChek.WDStockChek.Availability

string

The availability of the part

StockChek.WDStockChek.Email

string

The email address for the distributor

API.Status

object

Information on the state of the response

API.Status.Message

string

A success message or cause of a failed call

API.Status.DataFound

boolean

Whether or not data was found for the request

API.Status.TimeStamp

datetime

The date and time of the request

API.Status.InternalError

boolean

Whether 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