Search By Token
Given a search_token, returns all possible part matches.
Request Parameters
| Parameter | Description | Required |
|---|---|---|
| search_token | Exact or prefix part token to search on | yes |
| login | Customer login name | yes |
| apikey | The API Key provided during the registration process | yes |
| rows | Number of parts with unique itemIDs to return - max is 25; default 10 | no |
| start | Number in the search list from which to start outputting parts | no |
| fmt | JSON (default) or XML | no |
| mfrCd | Manufacturer code used to filter results. Given here. | no |
| utm_currency | Converts USD to selected currency. Example values (EUR, CAN) | no |
Example Request
API Address: http://api.arrow.com GET /itemservice/v3/en/search/token?login=<login>&apikey=<apikey>&search_token=bav99-7-f
Example Response
{
"itemserviceresult": {
"serviceMetaData": [
{
"version": "3.0.2"
}
],
"transactionArea": [
{
"response": {
"returnCode": "0",
"returnMsg": "",
"success": true
},
"responseSequence": {
"transactionTime": "32.298 ms",
"queryTime": "0 ms",
"dbTime": "0 ms",
"totalItems": 64,
"resources": [
],
"qq": 150
}
}
],
"data": [
{
"resources": [
{
"type": "search",
"uri": "https://www.arrow.com/en/products/search?q=bav99"
}
],
"PartList": [
{
"itemId": 21763417,
"partNum": "BAV99",
"manufacturer": {
"mfrCd": "DIOTCSEM",
"mfrName": "Diotec Semiconductor"
},
"desc": "Diode Small Signal Switching 85V 0.215A 3-Pin SOT-23 T/R",
"packageType": "",
"resources": [
{
"type": "cloud_part_detail",
"uri": "https://www.arrow.com/en/products/bav99/diotec-semiconductor-ag"
},
{
"type": "api_part_detail",
"uri": "https://api.arrow.com/itemservice/v2/en/detail?mfrCd=DIOTCSEM&partNum=BAV99"
},
{
"type": "part_detail",
"uri": "https://api.arrow.com/itemservice/v2/en/detail?pkey=PqZrH6HrwJyx3WVT0UpbGQhw245gnbhV7MPzLvouTtk"
}
],
"EnvData": {
"compliance": [
{
"displayLabel": "eurohs",
"displayValue": "Compliant"
},
{
"displayLabel": "cnrohs",
"displayValue": "Compliant"
}
]
},
"InvOrg": {
"sources": [
{
"currency": "USD",
"sourceCd": "VERICAL",
"displayName": "Verical",
"sourceParts": [
{
"packSize": 3000,
"minimumOrderQuantity": 3000,
"sourcePartNumber": "",
"sourcePartId": "35834312",
"Prices": {
"resaleList": [
{
"displayPrice": "0.012",
"price": 0.012,
"minQty": 3000,
"maxQty": 99999999,
}
]
},
"Availability": [
{
"fohQty": 3000,
"availabilityCd": "INSTK",
"availabilityMessage": "In Stock",
"pipeline": [
]
}
],
"customerSpecificPricing": [
],
"customerSpecificInventory": [
],
"dateCode": "1918",
"resources": [
{
"type": "detail",
"uri": "https://www.verical.com/pd/diotec-semiconductor-ag-rectifier-BAV99-1829897"
},
{
"type": "add_to_cart",
"uri": "https://www.verical.com/pd/diotec-semiconductor-ag-rectifier-BAV99-1829897"
}
],
"inStock": true,
"mfrLeadTime": 0,
"isNcnr": false,
"isNpi": false,
"isASA": false,
"requestQuantity": 0,
"productCode": "",
"iccLevels": [
],
"cloudMfrCode": "",
"eccnCode": "EAR99",
"htsCode": "8541.10.00.80",
"locationId": 46,
"containerType": ""
},
]
},
{
"currency": "USD",
"sourceCd": "EUROPE",
"displayName": "Europe",
"sourceParts": [
{
"packSize": 1,
"minimumOrderQuantity": 1,
"sourcePartNumber": "",
"sourcePartId": "E32:1076_06675236",
"Prices": {
"resaleList": [
{
"displayPrice": "0.0128",
"price": 0.0128,
"minQty": 1,
"maxQty": 9,
},
{
"displayPrice": "0.0126",
"price": 0.0126,
"minQty": 10,
"maxQty": 999999999,
}
]
},
"Availability": [
{
"fohQty": 416,
"availabilityCd": "INSTKEU",
"availabilityMessage": "In Stock",
"pipeline": [
{
"delivery": "20200622",
"quantity": 3000
}
]
}
],
"customerSpecificPricing": [
],
"customerSpecificInventory": [
],
"dateCode": "1918",
"resources": [
{
"type": "detail",
"uri": "https://www.arrow.com/en/products/bav99/diotec-semiconductor-ag"
},
{
"type": "add_to_cart",
"uri": "https://www.arrow.com/en/products/bav99/diotec-semiconductor-ag"
}
],
"inStock": true,
"mfrLeadTime": 12,
"isNcnr": false,
"isNpi": false,
"isASA": false,
"requestQuantity": 0,
"productCode": "",
"iccLevels": [
],
"cloudMfrCode": "",
"eccnCode": "EAR99",
"htsCode": "8541.10.00.80",
"locationId": 46,
"containerType": ""
},
]
}
]
},
"hasDatasheet": true
},
}
Response Elements
The response document returned by the “Search By Token” service may contain the following elements.
| JSON Element | Description |
|---|---|
| itemserviceresult | Container for the entire response |
| serviceMetaData | Child of itemservice result |
| version | Current version of endpoint |
| transactionArea | Child of itemservice result |
| response | Container for transaction status |
| responseSequence | Container for transaction metrics |
| response | Child of transactionArea |
| returnCode | 0 if successful, otherwise an error code |
| returnMsg | "" if successful, or descriptive message otherwise |
| sucess | "true" if successful, "false" otherwise |
| responseSequence | Child of transactionArea |
| transactionTime | Response time in miliseconds |
| queryTime | Time to transpose query internally |
| dbTime | Time for response from database |
| totalItems | Number of parts returned in response |
| resources | url of product |
| data | Child of itemserviceresult |
| resources | List of resource elements, each defind within {} |
| PartList | List of parts, each defined within {} |
| resource | Child of PartList[] instance, Multiple instances of: |
| type | Resource type, e.g. "search" |
| uri | Uniform Resource Identifier: HTTPS address |
| PartList[] | Child of data. Multiple instances of: |
| itemID | Arrow part identifier |
| partNum | Manufacturer Part Number (MPN) |
| manufacturer | Container for part manufacturer information |
| desc | Human-readable description of the part |
| packageType | Package type of part ID, if identified |
| resources | List of resource elements, each defined within {} |
| EnvData | Container for environmental data |
| InvOrg | Container for inventory data |
| hasDataSheet | “true” if a data sheet containing technical information is available, “false” otherwise |
| manufacturer | Child of a PartList[] instance |
| mfrCd | Short code identifying the manufacturer. Can be used for filtering with endpoints. |
| mfrName | Full display name of the manufacturer |
| EnvData | Child of a PartList[] instance |
| compliance | Container for compliance-related data |
| compliance | Child of EnvData. Multiple instances of: |
| displayLabel | Compliance label, e.g. “eurohs” |
| displayValue | Enum for compliant status: Compliant, Non Compliant, Unknown |
| InvOrg | Child of a PartList[] instance |
| sources | List of inventory sources, each contained in {} |
| sources | Child of InvOrg |
| currency | The currency used to express prices. Displayed in ISO code. Below are all Arrow accepted currencies
USD: US Dollar GBP: Great Britain Pound (Sterling) EUR: European Union Euro JPY: Japanese Yen SGD: Singapore Dollar AUD: Australian Dollar CAD: Canadian Dollar HKD: Hong Kong Dollar MYR: Malaysian Ringgit KRW: South Korean Won BRL: Brazilian Real CNY: China Yuan Renminbi INR: Indian Rupee MXN: Mexican Peso TWD: New Taiwan Dollar |
| sourceCd | A short identifier for the source/region of the inventory. The most common are:
ACNA: Arrow North America EUROPE: Arrow Europe ASIA: Arrow Asia VERICAL: Verical Marketplace |
| displayName | The full name for the source/region of the inventory, for example “Americas” |
| sourceParts | List of source parts, each contained in {} |
| sourceParts[] | Child of a source instance. Each element is a specific combination of part number, packaging, and inventory source. |
| packSize | Number of parts per package/reel |
| minimumOrderQuantity | The minimum number of parts that can be ordered. This will be a multiple of the packSize. |
| sourcePartNumber | Deprecated. Use "sourcePartId" |
| sourcePartId | Unique identifier for this source part. Needed for Automated Checkout API |
| Prices[] | Container for pricing data |
| Availability[] | List of elements containing inventory data |
| customerSpecificPricing[] | Reserved for future use |
| customerSpecificInventory[] | Reserved for future use |
| dateCode | Indicates the date the part was manufactured |
| resources[] | Container for Resource specific to listed sourcePartNumber | inStock | true if there is inventory available, false otherwise |
| mfrLeadTime | Lead time from Manufacturer. Listed in weeks |
| isNcnr | Non Cancellable-Non Returnable. If true, then part cannot be cancelled or returned once ordered. If false, part can be cancelled or returned after purchase. |
| isNpi | True if this is a new product, false if existing product. |
| isASA | Arrow Supply Assurance parts. Safe, factory direct supply of critical components after parts become obsolete. |
| requestQuantity | If requested quantity id specified, will display here. |
| productCode | Compressed part number |
| iccLevels[] | Deprecated data field. Will be blank |
| cloudMfrCode | Deprecated data field. Will be blank |
| eccnCode | Export Control Classification Number for listed part |
| htsCode | Harmonized Tariff Schedule code |
| locationId | Deprecated field. Please use sourcePartId instead |
| containerType | Packaging type if known |
| Prices | Child of a sourceParts[] instance |
| resaleList[] | List of price breaks, each contained in {} |
| resaleList[] | Child of Prices[] instance |
| displayPrice | Price as a string that can be displayed in a client application |
| price | Price as a numeric value |
| minQty | Minimum quantity which must be purchased to receive this price |
| maxQty | Maximum quantity which can be purchased before moving to the next price tier |
| vipPrice | If account is set up with Perks pricing this field will be displayed as “true” else field will not be returned. |
| Availability[] | Child of a sourceParts[] instance. Multiple instances of: |
| fohQty | Free On Hand Quantity, i.e. available inventory. |
| availabilityCd | A short code indicating part availability. |
| availabilityMessage | A longer descriptive string indicating part availability. |
| pipeline[] | Display part’s upcoming pipeline deliveries with date and inventory amount. |
| customerSpecificPricing[] | Child of a sourceParts[] instance. Reserved for future use. |
| customerSpecificInventory[] | Child of a sourceParts[] instance. Reserved for future use. |