Product API
Search the ABC Supply product catalog for items using different search criteria. Get product information with optional features such as same-family items and branch availability.
The Get All Items endpoint returns details for all available items in ABC Supply product catalog. The response includes details about each item and key product attributes, with optional embedding of branch availability, item variations, and related product family items. This endpoint allows a user to paginate through all items without any results filtering. Note that branch availability does not filter by branches to which the user has access.
Product API
Get All Items
GET /items
Get all items in ABC Supply product catalog
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the product.read scope.
Request
Query Parameters
Name
Type
Description
itemsPerPage
integer
The number of items to display per page. The maximum allowed value is 1000.
pageNumber
integer
The page number of the results to return from the request.
embed
string
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
The datetime the webhook was activated, in UTC (e.g., “2023-09-08T16:08:29.92Z”).
Example Request
Sample Request Payload with optional embedded branches, variations, and family items
GET /api/product/v1/items?itemsPerPage=10&pageNumber=1&embed=branches,variations&familyItems=true HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>Response
Example Response
Response with embedded branches, variations, and family items
{
"pagination": {
"itemsPerPage": 10,
"pageNumber": 1,
"totalPages": 21047,
"totalItems": 210470
},
"items": [
{
"itemNumber": "00030035",
"familyId": "PFam_3403732",
"familyName": "Coronado Stone Chiseled Window Stone Straight",
"itemDescription": "Coronado Stone 6\" X 8\" Window Trim Stone Light Grey",
"status": "Active",
"familyItems": [
{
"itemNumber": "030S136",
"itemDescription": "Coronado Stone 6\" X 8\" Window Stone S136",
"color": "N/A"
},
{
"itemNumber": "00030GS",
"itemDescription": "Coronado Stone 6\" X 8\" Window Trim Stone Gulf Sands",
"color": "N/A"
}
],
"color": {
"description": "Product Color",
"code": "927",
"name": "N/A"
},
"finish": {
"description": null,
"code": null,
"name": null
},
"weights": [
{
"value": "0.00010",
"uom": null,
"description": null
}
],
"uoms": [
{
"name": "Piece",
"code": "PC",
"description": "costing"
},
{
"name": "Piece",
"code": "PC",
"description": "stocking"
}
],
"dimensions": {
"width": {
"value": null,
"uom": null,
"description": "Width "
},
"thickness": {
"value": null,
"uom": null,
"description": "Thickness "
},
"height": {},
"variations": [
{
"size": "",
"conversionFactor": 1,
"type": "standard",
"length": {
"value": "",
"uom": "",
"uomCode": "",
"description": ""
}
}
]
},
"specifications": [
{
"name": "Spec Warranty",
"code": "143",
"description": "Dimensional Shingles - 143"
},
{
"name": "Special Attributes",
"code": "24",
"description": "Standard Colors"
},
{
"name": "Size Profile",
"code": "436",
"description": "N/A"
}
],
"prop65Warnings": [
{
"label": "WARNING: This product can expose you to Silica, crystalline (airborne particles of respirable size), which is 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": "00030035-product",
"type": "RepresentativeProductImageReference",
"href": "https://partners.abcsupply.com/product/v1/items/00030035/images/00030035-product"
}
],
"hierarchy": {
"productGroup": {
"name": "1860",
"code": "1860",
"label": "Siding Products",
"description": "Siding Products",
"category": {
"name": "000011 - Stucco, EIFS, Masonry & Other Siding Products",
"code": "11",
"label": "Stucco, EIFS, Masonry & Other Siding Products",
"description": "Stucco, EIFS, Masonry & Other Siding Products",
"productType": {
"name": "000173 - Stone Siding Products - ABC",
"code": "173",
"label": "Stone Siding Products - ABC",
"description": "Stone Siding Products - ABC",
"materialComposition": {
"name": "000053 - Brick, Stone And Cement Siding Prod",
"code": "53",
"label": "Brick, Stone And Cement Siding Prod",
"description": "Brick, Stone And Cement Siding Prod",
"warranty": {
"name": "001372 - Cultured Stone",
"code": "1372",
"label": "Cultured Stone",
"description": "Cultured Stone",
"brandLine": {
"name": "Coronado Stone - 005211",
"code": "5211",
"label": "Coronado Stone",
"description": "Coronado Stone"
}
}
}
}
}
}
},
"branches": [
{
"number": "33",
"links": {
"self": "https://api3-sb.abcsupply.com/dev-partners-location/api/location/v1/branches/33"
}
},
{
"number": "303",
"links": {
"self": "https://api3-sb.abcsupply.com/dev-partners-location/api/location/v1/branches/303"
}
}
]
},Name
Type
Description
pagination
object
The object containing pagination information.
pagination.itemsPerPage
integer
The number of items returned per page.
pagination.pageNumber
integer
The current page number of the response.
pagination.totalPages
integer
The number of total pages in the response.
pagination.totalItems
integer
The total number of items returned in the response.
items
array
This array contains item details.
items[].itemNumber
string
The ABC Supply item number.
items[].familyid
string
The unique ID for the product family.
items[].familyName
object
The name of the product family.
items[].itemDescription
string
The description of the item.
items[].status
string
The status of the item (e.g., “Active”, “Inactive”).
items[].familyItems
array
The list of items in the product family.
items[].familyItems[].itemNumber
object
The item number for the item in the product family.
items[].familyItems[].itemDescription
string
The description of the item in the product family.
items[].familyItems[].color
string
The color of the item in the product family.
items[].color
object
The object describing the item color.
items[].color.description
string
The description of the color.
items[].color.code
string
The code for the color.
items[].color.name
string
The name of the color.
items[].finish
object
The object describing the item finish.
items[].finish.description
string
The description of the finish.
items[].finish.code
string
The code for the finish.
items[].finish.name
string
The name of the finish.
items[].weights
array
The list of available weights of the item.
items[].weights[].value
string
The value of the weight of the item.
items[].weights[].uom
string
The unit of measure of the weight (e.g., “lbs”).
items[].weights[].description
string
The description of the unit of measure for the weight (e.g., “Weight (lbs.)”).
items[].uoms
array
The list of the units of measure of the item.
items[].uoms[].name
string
The name of the unit of measure.
items[].code
string
The code of the unit of measure.
items[].description
string
The description of the unit of measure.
items[].dimensions
object
The object describing the product dimensions.
items[].dimensions.width
object
The object describing the product width.
items[].dimensions.width.value
string
The value of the width dimension.
items[].dimensions.width.uom
string
The unit of measurement of the width dimension.
items[].dimensions.width.description
string
The description of the width unit of measure (e.g., “Width (ft.)”).
items[].dimensions.thickness
object
The object describing the item thickness.
items[].dimensions.thickness.value
string
The value of the thickness dimension.
items[].dimensions.thickness.uom
string
The unit of measurement of the thickness dimension.
items[].dimensions.thickness.description
string
The description of the thickness unit of measure (e.g., “Thickness (in.)”).
items[].dimensions.height
object
The object describing the height of the item.
items[].dimensions.height.value
string
The value of the height dimension.
items[].dimensions.height.uom
string
The unit of measurement of the height dimension.
items[].dimensions.height.description
string
The description of the height unit of measure (e.g., “Height (in.)”).
items[].dimensions.variations
array
The list of available variations for the size of the item.
items[].dimensions.variations[].size
string
The text of the size variation. (Available in a future release.)
items[].dimensions.variations[].conversionFactor
integer
The conversion factor of the variation.
items[].dimensions.variations[].type
string
Whether the size is standard or not.
items[].dimensions.variations[].length
object
The object describing the length variation for the item.
items[].dimensions.variations[].length.value
string
The value of the length variation.
items[].dimensions.variations[].length.uom
string
The unit of measure of the length variation.
items[].dimensions.variations[].length.uomCode
string
The unit of measure code of the length variation.
items[].dimensions.variations[].length.description
string
The description of the length variation unit of measure (e.g., “Length (in).”).
items[].specifications
array
The list of specifications for the item. (Available in a future release.)
items[].specifications.name
string
The name of a specification (e.g., “Spec Warranty”). (Available in a future release.)
items[].specifications.code
string
The code for the specification. (Available in a future release.)
items[].specifications.description
string
The description of the specification.
items[].prop65Warnings
array
The list of Proposition 65 warnings for the item.
items[].prop65Warnings[].label
string
The text of the proposition 65 warning.
items[].prop65Warnings[].display
boolean
The Boolean specifying if the warning should be displayed.
items[].prop65Warnings[].type
string
The type of the Proposition 65 warning (e.g., “chemical”).
items[].prop65Warnings[].locale
string
The localization language of the Proposition 65 warning.
items[].images
array
The list of image links available for the item.
items[].images[].assetId
string
The asset ID of the image link.
items[].images[].type
string
The type of image link (e.g., “RepresentativeProductImageReference”).
items[].images[].href
string
The URL for the image.
items[].hierarchy
object
The object describing the product hierarchy of the item.
items[].hierarchy.productGroup
object
The object describing the product group of the item.
items[].hierarchy.productGroup.name
string
The name of the product group.
items[].hierarchy.productGroup.code
string
The code for the product group.
items[].hierarchy.productGroup.label
string
The abbreviated description of the product group.
items[].hierarchy.productGroup.description
string
The full description of the product group.
items[].hierarchy.productGroup.category
object
The object describing the product category of the item.
items[].hierarchy.productGroup.category.name
string
The name of the product category.
items[].hierarchy.productGroup.category.code
string
The code for the product category.
items[].hierarchy.productGroup.category.label
string
The abbreviated description of the product category.
items[].hierarchy.productGroup.category.description
string
The full description of the product category.
items[].hierarchy.productGroup.category.productType
object
The object describing the product type of the item.
items[].hierarchy.productGroup.category.productType.name
string
The name of the product type.
items[].hierarchy.productGroup.category.productType.code
string
The code for the product type.
items[].hierarchy.productGroup.category.productType.label
string
The abbreviated description of the product type.
items[].hierarchy.productGroup.category.productType.description
string
The full description of the product type.
items[].hierarchy.productGroup.category.productType.materialComposition
object
The object describing the material composition of the item.
items[].hierarchy.productGroup.category.productType.materialComposition.name
string
The name of the material composition.
items[].hierarchy.productGroup.category.productType.materialComposition.code
string
The code for the material composition.
items[].hierarchy.productGroup.category.productType.materialComposition.label
string
The abbreviated description of the material composition.
items[].hierarchy.productGroup.category.productType.materialComposition.description
string
The full description of the material composition.
items[].hierarchy.productGroup.category.productType.materialComposition.warranty
object
The object describing the product warranty for the item.
items[].hierarchy.productGroup.category.productType.materialComposition.warranty.name
string
The name of the warranty.
items[].hierarchy.productGroup.category.productType.materialComposition.warranty.code
string
The code for the warranty.
items[].hierarchy.productGroup.category.productType.materialComposition.warranty.label
string
The abbreviated description of the warranty.
items[].hierarchy.productGroup.category.productType.materialComposition.warranty.description
string
The full description of the warranty.
items[].hierarchy.productGroup.category.productType.materialComposition.brandLine
object
The object describing the brand line of the item.
items[].hierarchy.productGroup.category.productType.materialComposition.brandLine.name
string
The name of the brand line.
items[].hierarchy.productGroup.category.productType.materialComposition.brandLine.code
string
The code for the brand line.
items[].hierarchy.productGroup.category.productType.materialComposition.brandLine.label
string
The abbreviated description of the brand line.
items[].hierarchy.productGroup.category.productType.materialComposition.brandLine.description
string
The full description of the brand line.
items[].branches
array
The list of ABC Supply branches with item availability. Note that the branches returned are not filtered by branches to which the user has access.
items[].branches[].number
string
The ABC Supply branch number.
items[].branches[].links
object
The object containing reference links for the ABC Supply branch.
items[].branches[].links.self
string
The API reference link for the ABC Supply branch.
HTTP Status Codes
Code
Status
Description
200
OK
Request and response succeeded.
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.
503
Service Unavailable
The server is experiencing a request overload due to rate limits or excessive traffic.