Get Item Availability

Product API

Search the ABC Supply product catalog and view product information. Get product availability and key product attributes across several product hierarchies.

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 Item Availability by Number endpoint returns availability of an item at ABC branches. The response includes a list of product variations available at the branches with availability, as well as a link to the branch resource.

Product API

GET /availability/items/{itemNumber}/branches

Get item availability at ABC Supply branches

Sandbox

Resource:

GET

https://partners-sb.abcsupply.com/api/product/v1/availability/items/{itemNumber}/branches

Production

Resource:

GET

https://partners.abcsupply.com/api/product/v1/availability/items/{itemNumber}/branches

Authorization

OAuth 2.0 server or user token with the product.read scope.

Request

URI Parameters

The unique identifier {itemNumber} for a specific item.

Example Request

GET /api/product/v1/availability/items/AAE23AL/branches HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>

Expand

Response

Example Response

{
    "branches": [
        {
            "number": "409",
            "name": "ABC Supply - Billings, MT",
            "links": {
                "self": "https://partners.abcsupply.com/location/v1/branches/409"
            },
            "variations": [
                {
                    "size": "1.5' X 4.5' X 4.9'",
                    "conversionFactor": 1,
                    "type": "standard",
                    "length": {
                        "value": "10",
                        "uom": "feet",
                        "uomCode": "ft",
                        "description": "Length (ft.)"
                    }
                }
            ]
        },
        {
            "number": "662",
            "name": "ABC Supply - Lenexa, KS",
            "links": {
                "self": "https://partners.abcsupply.com/location/v1/branches/662"
            },
            "variations": [
                {
                    "size": "1.5' X 4.5' X 4.9'",
                    "conversionFactor": 1,
                    "type": "standard",
                    "length": {
                        "value": "10",
                        "uom": "feet",
                        "uomCode": "ft",
                        "description": "Length (ft.)"
                    }
                }
            ]
        }
    ]
}

Expand

Name

Type

Description

branches

array

The list of ABC Supply branches with item availability.

branches[].number

string

The ABC Supply branch number.

branches[].name

string

The ABC Supply branch name., including the city and state.

branches[].links

object

The object containing reference links for the ABC Supply branch.

branches[].link.self

string

The API reference link for the ABC Supply branch.

branches[].variations

array

The list of available variations for the length of the item.

branches[].variations[].size

string

The text describing the length variation.

branches[].variations[].conversionFactor

float

The conversion factor, used for converting pricing unit of measure to ordering unit of measure.

branches[].variations[].type

enum

The type of the variation (e.g., “standard”).

branches[].variations[].length

object

The object describing the length of the variation.

branches[].variations[].length.uom

enum

The unit of measurement of the length variation.

branches[].variations[].length.value

string

The value of the length variation.

branches[].variations[].length.description

string

The description of the length variation unit of measurement (e.g., “Length (in).”).

branches[].variations[].length.uomCode

string

The unit of measurement code of the length variation.

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.

Product API

Product API