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 Product Favorites endpoint returns information about items which the user has marked as “Favorite” in the myABCSupply portal or using the Add Favorite Item endpoint. The endpoint response optionally includes item availability at a branch if the branch number is provided in the request.
Product API
Get Favorite Items
GET /items/{billToNumber}/favorites
Get favorite items for a Bill-To account
Sandbox
Production
Authorization
For Individuals and Businesses, use OAuth 2.0 server or user token with the product.read scope.
For Third-Party Aggregators, use OAuth 2.0 user token with the product.read scope.
Request
Query Parameters
Name
Type
Description
itemsPerPage
integer
The number of items to display per page.
pageNumber
integer
The page number of the results to return from the request.
branchNumber
integer
Optional ABC branch number to check availability of items in the response.
URI Parameters
The URI parameter {billToNumber} is the Bill-To account number.
Example Request
Request with optional branch provided for item availability
GET /api/product/v1/items/2015825-1/favorites?itemsPerPage=20&pageNumber=1&branchNumber=409 HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>Response
Example Response
Response payload with optional branch availability
{
"pagination": {
"itemsPerPage": 20,
"pageNumber": 1,
"totalPages": 1,
"totalItems": 1
},
"items": [
{
"itemNumber": "08CS303436",
"branchNumber": 409,
"familyId": "PFam_3357501",
"isAvailableForBranch": true,
"itemDescription": "CSI TPO Cut Edge Sealant Clear 16OZ",
"uom": "BO - Bottle",
"dimensions": [
{
"width": {
"value": 0,
"uom": null,
"description": "Width"
},
"thickness": {
"value": 0,
"uom": null,
"description": "Thickness"
}
}
],
"prop65Warnings": [
{
"label": "WARNING: This product can expose you to Titanium dioxide (airborne, unbound 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"
}
]
}
]
}Name
Type
Description
pagination
integer
The object containing pagination information.
pagination.pageNumber
integer
The current page number of the response.
pagination.pageCount
integer
The number of total pages in the response.
pagination.pageSize
integer
The number of items returned per page.
pagination.totalCount
integer
The total number of items returned in the response.
items
array
The list of favorite items for the provided Bill-To account.
items[].itemNumber
string
The ABC Supply item number.
items[].branchNumber
integer
The ABC Supply branch number provided in the request.
items[].isAvailableForBranch
boolean
The boolean value specifying if the item is available at the provided branch (e.g., true, false).
items[].isFavorite
boolean
The boolean value specifying if the item is marked as a favorite item for the provided Bill-To account (e.g., true, false).
items[].count
integer
The number of times the item has been invoiced for the provided Bill-To account in the last 90 days.
items[].itemDescription
string
The description of the item.
items[].uom
string
The unit of measure description used when ordering the item.
items[].dimensions
array
The list of available dimension information for the item, if applicable.
items[].dimensions[].width
object
The object describing the width of the item.
items[].dimensions[].width.value
float
The value of the item width.
items[].dimensions[].width.uom
string
The unit of measure of the item width (e.g., “in”).
items[].dimensions[].width.description
string
The description of the item width.
items[].dimensions[].thickness
object
The object describing the thickness of the item.
items[].dimensions[].thickness.value
float
The value of the item thickness.
items[].dimensions[].thickness.uom
string
The unit of measure of the item thickness (e.g., “in”).
items[].dimensions[].thickness.description
string
The description of the item thickness.
items[].prop65Warnings
array
The list of Proposition 65 warnings for the item.
items[].prop65Warnings[].label
string
The description of the warning.
items[].prop65Warnings[].type
boolean
The boolean specifying if the warning should be displayed.
items[].prop65Warnings[].display
string
The type of the warning (e.g., “chemical”).
items[].prop65Warnings[].locale
string
The localization language of the warning.
HTTP Status Codes
Code
Status
Description
200
OK
The request and response were sent successfully.
400
Bad Request
Ensure the query parameters and values provided are valid.
401
Unauthorized
The provided account does not have access to the requested date. Ensure the provided account is a valid Bill-To account for the user.
500
Internal Server Error
The server was unable to process the request.