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.
Please ensure that your use of this API endpoint complies with the API Terms of Use. Using the ABC Supply API to offer price comparisons with competitive third-party services is in violation of the API Terms of Use.
The Search Items Availability endpoint returns a list of items and the branches where the items are available for ordering. This endpoint requires a list of item numbers or branch numbers to be provided in the request. The request may also specify pagination parameters. The response includes a paginated collection of item availability at various branches.
Product API
Search Item Availability
POST /search/availability/items
Search for item availability by item numbers or branch numbers
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the product.read scope.
Request
Name
Type
Description
filters
array
The list of filters for the item availability search.
filters[].key
string
The type of filter for the search (e.g., “itemNumber”, “branchNumber”).
filters[].condition
string
The filter condition for the search (e.g., “contains”, “equals”, “in”).
filters[].values
array
The list of values for the filter condition of the search.
pagination
object
The object containing the pagination details for the search results.
pagination.itemsPerPage
integer
The number of items displayed per page in the search results. Defaults to 50 items per page.
pagination.pageNumber
integer
The current page number to display in the search results. Defaults to page 1.
Example Request
Sample Request Payload.
POST /api/product/v1/search/availability/items HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>
{
"filters": [
{
"key": "itemNumber",
"condition": "in",
"values": [
"U58X",
"300"
]
}
],
"pagination": {
"itemsPerPage": 20,
"pageNumber": 1
}
}Response
Example Response
Sample Response Payload
{
"pagination": {
"itemsPerPage": 20,
"pageNumber": 2,
"totalPages": 5,
"totalItems": 100
},
"availability": [
{
"branchNumber": 400,
"itemNumber": "300",
"size": "1.5' X 4.5' X 4.9'",
"conversionFactor": 1,
"length": {
"value": "10",
"uomCode": "ft"
},
"type": "standard"
},
{
"branchNumber": 409,
"itemNumber": "U58FX",
"size": "1.5' X 4.5' X 4.9'",
"conversionFactor": 1,
"length": {
"value": "10",
"uomCode": "ft"
},
"type": "standard"
}
]
}Name
Type
Description
pagination
object
The object containing the pagination details for the search results.
pagination.itemsPerPage
integer
The number of items displayed per page in the search results.
pagination.pageNumber
integer
The current page number of the search results.
pagination.totalPages
integer
The number of total pages of search results.
pagination.totalItems
integer
The total number of items in the search results.
availability
array
The list of information for the item availability.
availability[].branchNumber
integer
The ABC Supply branch number where the item is available.
availability[].itemNumber
string
The ABC Supply item number.
availability[].size
string
The text of the item size.
availability[].conversionFactor
float
The conversion factor, used for converting pricing unit of measure to ordering unit of measure.
availability[].length
object
The object describing the length of the item.
availability[].length.value
string
The value of the length.
availability[].length.uomCode
string
The unit of measurement of the length.
availability[].length.type
string
The type of the item size variation (e.g., “standard”).
HTTP Status Codes
Name
Type
Description
400
Bad Request
Check the Request to make sure the Request Body and Parameters are passed correctly based on the API documentation.
404
Object Not Found
The request returned empty or no object. Please check the object identifier.