How Can We Help?
Item Inquiry Transaction
The Item Inquiry is used to get pricing and availability information for display in the web catalog. The request and response JSON strings are defined below. The response that is returned may be for any of the following part types which are defined on the target system.
- Requested Part (0): This is required to be returned for the requested parts.
- Alternate Part (1): This part generally indicates that it is an alternate for the requested part.
- Equivalent Part (2): This part generally indicates that it is an equivalent replacement for the requested part.
- Superseded Part (3): This part indicates that the requested part has been Superseded or replaced by this part.
Request JSON Example (Version 1.0)
The following is an example of the JSON string that will be posted. The schema below describes all of the elements.
{
"iteminquiryrequest": {
"version": "1.0",
"integrationtype": "FLK",
"utctime": "2014-07-04 11:00:26",
"transid": "5038ab89-d86a-4c32-9206-ec50f7a40a02",
"accountid": "854200",
"memberno": "###",
"username": "",
"password": "",
"locations": [
{
"locationid": "Branch1",
"sortorder": 0,
"locationtype": "store",
"canorder": true
},
{
"locationid": "Branch2",
"sortorder": 1,
"locationtype": "store",
"canorder": false
}
],
"items": [
{
"index": 1,
"mfrcode": "HAS",
"partno": "LF115",
"qtyreq": 1
},
{
"index": 2,
"mfrcode": "FEF",
"partno": "LF115F",
"qtyreq": 1
}
]
}
}
Request JSON Schema (Version 1.0)
{
"title": "Item Inquiry Request JSON Schema (Version 1.0)",
"type": "object",
"properties": {
"iteminquiryrequest": {
"type": "object",
"properties": {
"accountid": {
"description": "This is the account that will be used for ordering when the items are placed in the cart and then ordered.",
"type": "string"
},
"username": {
"description": "Specifies the username of the User making the Request. This user must be first setup in FederatedLink.com. If the user is not setup, the request will fail with an authentication error.",
"type": "string"
},
"password": {
"description": "Specifies the Password for the User that is making the Request.",
"type": "string"
},
"memberno": {
"description": "Specifies the Group Member Number for the User making the Request. This value is used to determine where the request is ultimately to be sent and in what format. This is setup within FederatedLink.com.",
"type": "string"
},
"transid": {
"description": "A unique transaction ID. This same ID should be returned in the response.",
"type": "string"
},
"version": {
"description": "Specifies the version being used. At this time, all requests use version 1.0.",
"type": "string"
},
"integrationtype": {
"description": "Specifies the integration type from which the request originated. If this is not a valid integration type, the request will fail with an 'invalid integrate type' error. New integrations will be assigned a new unique three character type",
"type": "string"
},
"utctime": {
"description": "UTC Date/Time that this JSON request is created (yyyy-DD-mm hh:mm:ss)",
"type": "string"
}
},
"locations": {
"type": "array",
"locations": {
"description": "An array containing the branch location(s) ID being requested. These must be setup in FederatedLink.com prior top the request being made.",
"type": "object",
"properties": {
"locationid": {
"description": "The location ID. This is typically a branch number or abbreviation",
"type": "string"
},
"sortorder": {
"description": "The order in which the location will be sorted.",
"type": "integer"
},
"locationtype": {
"description": "The location type (E.g. store, whse, office, etc.)",
"type": "string"
},
"canorder": {
"description": "Whether or not an order can be placed to this location",
"type": "boolean"
}
}
}
},
"items": {
"type": "array",
"items": {
"description": "An array containing the item(s) being inquired.",
"type": "object",
"properties": {
"index": {
"description": "A unique ID used to identify the match the returned results. This will be a unique value. If you receive this request from the FederatedLink.com website, this exact value must be returned in the response.",
"type": "integer"
},
"mfrcode": {
"description": "The FederatedLink.com Manufacturer Code (MfrCode: 3 character alpha-numeric) if you are using the FederatedLink.com SKU table. If this request comes from a Stock Order and you are not using the FederateLink.com SKU table this value will be blank. In all other cases it will be populated.",
"type": "string"
},
"partno": {
"description": "The part number.",
"type": "string"
},
"qtyreq": {
"description": "The number of items being requested (this would typically be the per car quantity).",
"type": "number"
}
}
}
}
}
}
}
Response JSON Example (Version 1.0)
The following is an example of the JSON string to be returned
{
"iteminquiryresponse": {
"version": "1.0",
"utctime": "2014-07-04 11:00:27",
"transid": "5038ab89-d86a-4c32-9206-ec50f7a40a02",
"status": "success",
"errordescription": "",
"accountid": "854200",
"vicdata": [
{
"ediid": "12345",
"locationid": "123123",
"shipto": [
{
"partyID": "123123",
"companyName": "My Auto Store",
"address1": "123 N. Main St",
"city": "Anytown",
"state": "VA",
"zipcode": "22980",
"country": "US"
}
],
"billto": [
{
"partyID": "123123",
"companyName": "My Auto Store",
"address1": "123 N. Main St",
"city": "Anytown",
"state": "VA",
"zipcode": "22980",
"country": "US"
}
]
}
],
"items": [
{
"id": 1,
"status": "success",
"errormessage": "",
"mfrcode": "HAS",
"mfrdescription": "",
"partno": "LF115",
"partdescription": "",
"parttype": "",
"comment": "0",
"bulkpricing": [
{
"break": 10,
"price": 2.99
},
{
"break": 20,
"price": 2.79
},
{
"break": 30,
"price": 2.59
}
],
"locations": [
{
"locationid": "Branch1",
"sortorder": 0,
"locationtype": "store",
"canorder": true,
"qtyavailable": 3,
"list": 7.8,
"cost": 3.25,
"core": 0,
"multiplier": 1,
"unitofmeasure": "",
"outofstockmsg": ""
},
{
"locationid": "Branch2",
"sortorder": 1,
"locationtype": "store",
"canorder": false,
"qtyavailable": 51,
"list": 7.8,
"cost": 3.25,
"core": 0,
"multiplier": 1,
"unitofmeasure": "",
"outofstockmsg": ""
}
],
"alternates": [
{
"id": "ALT_<UniqueNumber-or-SKU>",
"status": "success",
"mfrcode": "DOR",
"mfrdescription": "",
"partno": "M76162",
"partdescription": "",
"parttype": "1",
"comment": "",
"bulkpricing": [],
"locations": [
{
"locationid": "Branch1",
"locationdesc": "",
"sortorder": 1,
"locationtype": "store",
"canorder": true,
"qtyavailable": 0,
"list": 0,
"cost": 0,
"core": 0,
"multiplier": 1,
"unitofmeasure": "each",
"outofstockmsg": ""
},
{
"locationid": "Branch2",
"locationdesc": "",
"sortorder": 2,
"locationtype": "store",
"canorder": true,
"qtyavailable": 0,
"list": 0,
"cost": 0,
"core": 0,
"multiplier": 1,
"unitofmeasure": "each",
"outofstockmsg": ""
}
]
}
]
},
{
"id": 2,
"status": "success",
"mfrcode": "FEF",
"mfrdescription": "",
"partno": "LF115F",
"partdescription": "",
"parttype": "",
"comment": "",
"bulkpricing": [],
"locations": [
{
"locationid": "Branch1",
"sortorder": 0,
"locationtype": "store",
"canorder": true,
"qtyavailable": 12,
"list": 5,
"cost": 1.77,
"core": 0,
"multiplier": 1,
"unitofmeasure": "",
"outofstockmsg": ""
},
{
"locationid": "Branch2",
"sortorder": 1,
"locationtype": "store",
"canorder": false,
"qtyavailable": 108,
"list": 5,
"cost": 1.77,
"core": 0,
"multiplier": 1,
"unitofmeasure": "",
"outofstockmsg": ""
}
]
}
]
}
}
Response JSON Schema (Version 1.0)
The data types listed below must be adhered to or the application may not process the response. The data structure for ‘Alternate’, ‘Equivalent’ and ‘Superseded’ parts are identical to the ‘Location’ structure.
{
"iteminquiryresponse": {
"version": {
"description": "Specifies the version being used.",
"type": "string"
},
"utctime": {
"description": "UTC Date/Time this JSON string is created (yyyy-DD-mm hh:mm:ss)",
"type": "string"
},
"transid": {
"description": "A unique transaction ID matching the Transaction ID of the request.",
"type": "string"
},
"status": {
"description": "The Status of the response ",
"type": "string"
},
"errordescription": {
"description": "The description of the error of the response ",
"type": "string"
},
"accountid": {
"description": "Account Number",
"type": "string"
},
"items": [
{
"id": {
"description": "Unique string identifying this Item. It MUST match the ID sent in the Request ",
"type": "string"
},
"status": {
"description": "Status of the request for this Item ",
"type": "string"
},
"errormessage": {
"description": "Error message related to this line item",
"type": "string"
},
"mfrcode": {
"description": "Manufacturer Code for this Item.",
"type": "string"
},
"mfrdescription": {
"description": "Manufacturer Description for this Item ",
"type": "string"
},
"partno": {
"description": "Part Number for this Item ",
"type": "string"
},
"partdescription": {
"description": "Part Description for this Item ",
"type": "string"
},
"parttype": {
"description": "Part Type for this Item; "0" - Requested Part; "1" - Alternate Part; "2" - Equivalent Part; "3" - Superceded Part ",
"type": "string"
},
"comment": {
"description": "Part Comment for this Item. This is not used in the current release. ",
"type": "string"
},
"locations": [
{
"locationid": {
"description": "Location ID. This must eactly match how this Location is define in Location Management.",
"type": "string"
},
"sortorder": {
"description": "Sort Order for the Location. Sort Order of '1' indicates teh default Location.",
"type": "integer"
},
"locationtype": {
"description": "Type of Location, i.e. 'store', 'office' or 'whse'.",
"type": "string"
},
"canorder": {
"description": "Can the Account order from this Location.",
"type": "boolean"
},
"qtyavailable": {
"description": "Number of units available at this Location.",
"type": "integer"
},
"list": {
"description": "List Price of the Item at this Location.",
"type": "double"
},
"cost": {
"description": "Cost of the Item at this Location.",
"type": "double"
},
"core": {
"description": "Core Charge for this Item at this Location.",
"type": "double"
},
"multiplier": {
"description": "Multiplier for this Item.",
"type": "integer"
},
"unitofmeasure": {
"description": "Unit of Measure for this Item.",
"type": "string"
},
"outofstockmsg": {
"description": "Message to display in the Part Box when this location does not have on hand quantities.",
"type": "string"
}
}
],
"alternates": [
{
"id": "ALT_<UniqueNumber-or-SKU>",
"status": "success",
"mfrcode": "DOR",
"mfrdescription": "",
"partno": "M76162",
"partdescription": "",
"parttype": "1",
"comment": "",
"locations": [
{
"locationid": "Branch1",
"locationdesc": "",
"sortorder": 1,
"locationtype": "store",
"canorder": true,
"qtyavailable": 0,
"list": 0,
"cost": 0,
"core": 0,
"multiplier": 1,
"unitofmeasure": "each",
"outofstockmsg": ""
},
{
"locationid": "Branch2",
"locationdesc": "",
"sortorder": 2,
"locationtype": "store",
"canorder": true,
"qtyavailable": 0,
"list": 0,
"cost": 0,
"core": 0,
"multiplier": 1,
"unitofmeasure": "each",
"outofstockmsg": ""
}
]
}
],
"equivalents": [
{
"id": "EQV_<UniqueNumber-or-SKU>",
"status": "success",
"mfrcode": "DOR",
"mfrdescription": "",
"partno": "M76162",
"partdescription": "",
"parttype": "2",
"comment": "",
"bulkpricing": [],
"locations": [
{
"locationid": "Branch1",
"locationdesc": "",
"sortorder": 1,
"locationtype": "store",
"canorder": true,
"qtyavailable": 0,
"list": 0,
"cost": 0,
"core": 0,
"multiplier": 1,
"unitofmeasure": "each",
"outofstockmsg": ""
},
{
"locationid": "Branch2",
"locationdesc": "",
"sortorder": 2,
"locationtype": "store",
"canorder": true,
"qtyavailable": 0,
"list": 0,
"cost": 0,
"core": 0,
"multiplier": 1,
"unitofmeasure": "each",
"outofstockmsg": ""
}
]
}
],
"supercessions": [
{
"id": "ALT_<UniqueNumber-or-SKU>",
"status": "success",
"mfrcode": "DOR",
"mfrdescription": "",
"partno": "M76162",
"partdescription": "",
"parttype": "3",
"comment": "",
"bulkpricing": [],
"locations": [
{
"locationid": "Branch1",
"locationdesc": "",
"sortorder": 1,
"locationtype": "store",
"canorder": true,
"qtyavailable": 0,
"list": 0,
"cost": 0,
"core": 0,
"multiplier": 1,
"unitofmeasure": "each",
"outofstockmsg": ""
},
{
"locationid": "Branch2",
"locationdesc": "",
"sortorder": 2,
"locationtype": "store",
"canorder": true,
"qtyavailable": 0,
"list": 0,
"cost": 0,
"core": 0,
"multiplier": 1,
"unitofmeasure": "each",
"outofstockmsg": ""
}
]
}
]
},
{
"id": 2,
"status": "success",
"mfrcode": "FEF",
"mfrdescription": "",
"partno": "LF115F",
"partdescription": "",
"parttype": "",
"comment": "",
"bulkpricing": [],
"locations": [
{
"locationid": "Branch1",
"sortorder": 0,
"locationtype": "store",
"canorder": true,
"qtyavailable": 12,
"list": 5,
"cost": 1.77,
"core": 0,
"multiplier": 1,
"unitofmeasure": "",
"outofstockmsg": ""
},
{
"locationid": "Branch2",
"sortorder": 1,
"locationtype": "store",
"canorder": false,
"qtyavailable": 108,
"list": 5,
"cost": 1.77,
"core": 0,
"multiplier": 1,
"unitofmeasure": "",
"outofstockmsg": ""
}
]
}
]
}
}