Product API
Search the ABC Supply product catalog and view product information. Get product availability and key product attributes across several product hierarchies.
The Get Item endpoint returns information about a specific item sold at various branches. The response includes details about the item and key product attributes, such as color, dimension, material hazard, size, image links, Proposition 65 warnings, and a reference to product hierarchy.
Product API
Get Item
GET /items/{itemNumber}
Get information for a specific item
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the product.read scope.
Request
URI Parameters
The unique identifier {itemNumber} for a specific item.
Query Parameters
Name
Type
Description
embed
enum
Optional embedded item information (e.g., “branches”, “variations”).
- “branches” embeds the branches where the item is available for purchase.
- “variations” embeds the length variations available for the item, if applicable .
familyItems
boolean
Optionally returns an embedded array of same-product family items within each item returned (e.g., “true”, “false”). Defaults to “false” if not included in the request. Please note that this functionality may reduce the endpoint’s performance and family items in response are not filtered by availability at the user’s branches.
Example Request
Get Item request with embedded branches, variations, and Product Family items.
GET /api/product/v1/items/02GASTZ3WW?embed=[branches, variations]&familyItems=true HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>Response
Example Response
Get Item response payload with embedded branches, variations, and Product Family items.
{
"itemNumber": "02GASTZ3WW",
"familyId": "PFam_3346590",
"familyName": "GAF Timberline High Definition HDZ Architectural Shingles",
"itemDescription": "GAF StainGuard Timberline HDZ with StrikeZone Shingles Weathered Wood 3 Bundles per Square",
"status": "Active",
"familyItems": [
{
"itemNumber": "02GASTZ3PG",
"itemDescription": "GAF StainGuard Timberline HDZ with StrikeZone Shingles Pewter Gray 3 Bundles per Square",
"color": "Pewter Grey"
},
{
"itemNumber": "02GATZ3CD",
"itemDescription": "GAF Timberline HDZ with StrikeZone Shingles Canadian Driftwood 3 Bundles per Square",
"color": "Canadian Driftw"
}
],
"color": {
"description": "Product Color",
"code": "384",
"name": "Weatherwood"
},
"finish": {
"description": null,
"code": null,
"name": null
},
"weights": [
{
"value": "0.00010",
"uom": "BD",
"description": "Weight (BD)"
}
],
"uoms": [
{
"name": "Square",
"code": "SQ",
"description": "costing"
},
{
"name": "Bundle",
"code": "BD",
"description": "stocking"
}
],
"dimensions": {
"width": {
"value": "",
"uom": "",
"description": "Width ()"
},
"thickness": {
"value": "",
"uom": "",
"description": "Thickness ()"
},
"height": {},
"variations": [
{
"size": "1.5' X 4.5' X 4.9'",
"conversionFactor": 1,
"type": "standard",
"length": {
"value": "10",
"uom": "feet",
"uomCode": "ft",
"description": "Length (ft.)"
}
}
]
},
"specifications": [
{
"name": "Spec Warranty",
"code": "143",
"description": "Dimensional Shingles - 143"
},
{
"name": "Special Attributes",
"code": "24",
"description": "Standard Colors"
},
{
"name": "Size Profile",
"code": "610",
"description": "Metric"
}
],
"prop65Warnings": [
{
"label": "WARNING: This product can expose you to chemicals including Silica, crystalline (airborne particles of respirable size),Titanium dioxide (airborne, unbound particles of respirable size), which are known to the State of California to cause cancer. For more information go to www.P65Warnings.ca.gov.",
"display": true,
"type": "chemical",
"locale": "English"
}
],
"images": [
{
"assetId": "02gatz3ww-product",
"type": "RepresentativeProductImageReference",
"href": "https://partners.abcsupply.com/product/v1/items/02GASTZ3WW/images/02gatz3ww-product"
}
],
"hierarchy": {
"productGroup": {
"name": "1000",
"code": "1000",
"label": "Steep Slope Products",
"description": "Steep Slope Products",
"category": {
"name": "000013 - Steep Slope Roofing (<gt/>2:12 Pitch)",
"code": "13",
"label": "Steep Slope Roofing (<gt/>2:12 Pitch)",
"description": "Steep Slope Roofing (<gt/>2:12 Pitch)",
"productType": {
"name": "000070 - Fiberglass Laminated Shingles",
"code": "70",
"label": "Fiberglass Laminated Shingles",
"description": "Fiberglass Laminated Shingles",
"materialComposition": {
"name": "000062 - Asphalt Composition Shingles and Hip & Ridge",
"code": "62",
"label": "Asphalt Composition Shingles and Hip & Ridge",
"description": "Asphalt Composition Shingles and Hip & Ridge",
"warranty": {
"name": "000143 - Dimensional Shingles",
"code": "143",
"label": "Dimensional Shingles",
"description": "Dimensional Shingles",
"brandLine": {
"name": "GAF Timberline HD - 003232",
"code": "3232",
"label": "GAF Timberline HD",
"description": "GAF Timberline HD"
}
}
}
}
}
}
},
"branches": [
{
"number": "118",
"links": {
"self": "https://partners.abcsupply.com/api/location/v1/branches/118"
}
},
{
"number": "89",
"links": {
"self": "https://partners.abcsupply.com/api/location/v1/branches/89"
}
}
]
}Name
Type
Description
itemNumber
string
The ABC Supply item number.
familyId
string
The unique ID for the product family.
familyName
string
The name of the product family.
itemDescription
string
The description of the item.
status
enum
The status of the item (e.g., “Active”, “Inactive”).
familyItems
array
The list of items in the product family.
familyItems[].itemNumber
string
The item number for the item in the product family.
familyItems[].itemDescription
string
The description of the item in the product family.
familyItems[].color
string
The color of the item in the product family.
color
string
Color Description.
color
object
The object describing the item color.
color.description
string
The description of the color.
color.code
string
The code for the color.
color.name
string
The name of the color.
finish
object
The code for the finish. (Available in a future release.)
finish.code
string
The code for the finish, if applicable. (Available in a future release.)
finish.name
string
The name of the finish. (Available in a future release.)
finish.description
string
The description of the finish. (Available in a future release.)
weights
array
The list of available weights of the item.
weights[].uom
enum
The unit of measure of the weight (e.g., “lbs”).
weights[].value
string
The value of the weight.
weights[].description
string
The description of the unit of measure for the weight (e.g., “Weight (lbs.)”).
uoms
array
The list of the units of measure of the item.
uoms[].name
string
The name of the unit of measure.
uoms[].code
string
The code of the unit of measure.
uoms[].description
string
The description of the unit of measure.
dimensions
object
The object describing product dimensions.
dimensions.width
object
The object describing the width of the item.
dimensions.width.uom
enum
The unit of measure of the width.
dimensions.width.value
string
The value of the width.
dimensions.width.description
string
The description of the width unit of measure (e.g., “Width (ft.)”).
dimensions.thickness
object
A object describing the thickness of the item.
dimensions.thickness.uom
enum
The unit of measure of the thickness.
dimensions.thickness.value
string
The value of the thickness.
dimensions.thickness.description
string
The description of the thickness unit of measure (e.g., “Thickness (in.)”).
dimensions.height
object
The object describing the height of the item. (Available in a future release.)
dimensions.height.uom
enum
The unit of measure of the height. (Available in a future release.)
dimensions.height.value
string
The value of the height. (Available in a future release.)
dimensions.height.description
string
The description of the height unit of measure (e.g., “Height (in.)”). (Available in a future release.)
dimensions.variations
array
The list of available variations for the length of the item.
dimensions.variations[].size
string
The text of the length variation.
dimensions.variations[].conversionFactor
float
The conversion factor, used for converting pricing unit of measure to ordering unit of measure.
dimensions.variations[].type
enum
The type of the variation (e.g., “standard”).
dimensions.variations[].length
object
The object describing the length variation for the item.
dimensions.variations[].length.uom
enum
The unit of measurement of the length dimension.
dimensions.variations[].length.value
string
The value of the length variation.
dimensions.variations[].length.description
string
The description of the length variation unit of measure (e.g., “Length (in).”).
dimensions.variations[].length.uomCode
string
The unit of measure code of the length variation.
specifications
array
The list of specifications for the item.
specifications[].name
string
The name of a specification (e.g., “Spec Warranty”).
specifications[].code
string
The code for the specification.
specifications[].description
string
The description of the specification.
prop65Warnings
array
The list of Proposition 65 warnings for the item.
prop65Warnings[].label
string
The description of the warning.
prop65Warnings[].display
boolean
The boolean specifying if the warning should be displayed.
prop65Warnings[].type
enum
The type of the warning (e.g., “chemical”).
prop65Warnings[].locale
string
The localization language of the warning.
images
array
The list of image links available for the item. (Available in a future release.)
images[].assetId
string
The asset ID of the image link. (Available in a future release.)
images[].type
enum
The type of image link (e.g., “RepresentativeProductImageReference”). (Available in a future release.)
images[].href
string
The URL for the image. (Available in a future release.)
hierarchy
object
The object describing the product hierarchy of the item.
hierarchy.productGroup
object
The object describing the product group of the item.
hierarchy.productGroup.name
string
The name of the product group.
hierarchy.productGroup.code
string
The code for the product group.
hierarchy.productGroup.description
string
The full description of the product group.
hierarchy.productGroup.label
string
The abbreviated description of the product group.
hierarchy.productGroup.category
object
The object describing the product category of the item.
hierarchy.productGroup.category.name
string
The name of the product category.
hierarchy.productGroup.category.code
string
The code for the product category.
hierarchy.productGroup.category.description
string
The full description of the product category.
hierarchy.productGroup.category.label
string
The abbreviated description of the product category.
hierarchy.productGroup.category.productType
object
The object describing the product type of the item.
hierarchy.productGroup.category.productType.name
string
The name of the product type.
hierarchy.productGroup.category.productType.code
string
The code for the product type.
hierarchy.productGroup.category.productType.description
string
The full description of the product type.
hierarchy.productGroup.category.productType.label
string
The abbreviated description of the product type.
hierarchy.productGroup.category.productType.materialComposition
object
The object describing the material composition of the item.
hierarchy.productGroup.category.productType.materialComposition.name
string
The name of the material composition.
hierarchy.productGroup.category.productType.materialComposition.code
string
The code for the material composition.
hierarchy.productGroup.category.productType.materialComposition.description
string
The full description of the material composition.
hierarchy.productGroup.category.productType.materialComposition.label
string
The abbreviated description of the material composition.
hierarchy.productGroup.category.productType.materialComposition.warranty
object
The object describing the product warranty for the item.
hierarchy.productGroup.category.productType.materialComposition.warranty.name
string
The name of the warranty.
hierarchy.productGroup.category.productType.materialComposition.warranty.code
string
The code for the warranty.
hierarchy.productGroup.category.productType.materialComposition.warranty.description
string
The full description of the warranty.
hierarchy.productGroup.category.productType.materialComposition.warranty.label
string
The abbreviated description of the warranty.
hierarchy.productGroup.category.productType.materialComposition.brandLine
object
The object describing the brand line of the item.
hierarchy.productGroup.category.productType.materialComposition.brandLine.name
string
The name of the brand line.
hierarchy.productGroup.category.productType.materialComposition.brandLine.code
string
The code for the brand line.
hierarchy.productGroup.category.productType.materialComposition.brandLine.description
string
The full description of the brand line.
hierarchy.productGroup.category.productType.materialComposition.brandLine.label
string
The abbreviated description of the brand line.
branches[]
array
The list of ABC Supply branches with item availability.
branches[].name
string
The ABC Supply branch name.
branches[].number
string
The ABC Supply branch number.
branches[].links
object
The object containing reference links for the ABC Supply branch.
branches[].links.self
string
The API reference link for the ABC Supply branch.
HTTP Status Codes
Code
Status
Description
200
OK
The request and response were successfully sent.
400
Bad Request
Confirm the request body and parameters are formatted correctly.
403
Forbidden
The user account does not have access to view data based on provided request parameters.
500
Internal Server error
The server was unable to process the request.
502
Bad Gateway
The server was unable to complete the request due to upstream errors.