Developer Guide

Use the Developer Guide to find the onboarding process steps, information about authentication methods, and a comprehensive list of the available ABC API endpoints.

Developer Guide

Release Notes

  • 2025.09.09 Release

    Now Available

    Order API

    Place Orders – Delivery Instructions increased to 255 characters

    The Place Orders endpoint now allows up to 255 characters to be sent for the deliveryAppointment.instructions field.

    NOTE: Once the order is sent to the branch, the branch will need to reduce the delivery message to 25 characters to store in our ERP. They will shorten and abbreviate as needed to convey the message to their delivery personnel. Please expect possible changes to the original delivery instructions by the branch associates after the order is submitted.

  • 2025.08.13 Release

    Now Available

    Product API

    Get Frequent Items – FamilyId Added to Response

    The familyId is now returned for each item in the Get Frequent Items response. Please see the example below.

    {
        "pagination": {
            "pageNumber": 1,
            "pageCount": 100,
            "pageSize": 1,
            "totalCount": 100
        },
        "items": [
            {
                "itemNumber": "58FSIS3048",
                "branchNumber": 28,
                "familyId": "PFam_3475276",
                "isAvailableForBranch": true,
                "isFavorite": false,
                "count": 29,
                "itemDescription": "Elevate 3.0 Iso 4' X 8'",
                "uom": "SH  -  Sheet",
                "dimensions": [
                    {
                        "width": {
                            "value": 0,
                            "uom": null,
                            "description": "Width"
                        },
                        "thickness": {
                            "value": 0,
                            "uom": null,
                            "description": "Thickness"
                        }
                    }
                ]
            }
        ]
    }

    Order API

    Place Orders – Validation for Orders with More Than 99 Items

    ABC Supply does not currently accept orders with more than 99 items on our old ERP system. For accounts limited by this situation, the following error will be returned in our Place Orders endpoint:

    202 ACCEPTED
    
    {
        "request": {
            "batchId": "B11558177",
            "recievedTime": "2025-08-13T16:17:07.797",
            "ordersReceived": 1,
            "ordersFailed": 1,
            "ordersSucceded": 0
        },
        "orders": [
            {
                "requestId": "1755119826424",
                "confirmationNumber": null,
                "message": "\"Orders are limited to less than 100 line items for this account. Please reduce the number of line items and resubmit your order.\""
            }
        ]
    }

  • 2025.05.27 Release

    Now Available

    Order API

    Place Order – Validation for Accounts and Branches on Same ERP System

    ABC Supply is currently migrating to a new ERP system. As branches migrate, new customer account numbers are created for existing customers since the new ERP system cannot recognize legacy account numbers. To prevent order failures, we’ve enhanced the Place Orders endpoint with validation that ensures both the branch and customer account numbers originate from the same ERP system before processing your order.

    If an order is submitted with an ERP mismatch, the Place Order response will have a status code of 202 Accepted but the “ordersFailed” field will have a count of 1 for every order from the request that failed. The error message returned will be the following:

    "The branch  and shipTo number  do not match the same ERP System. Please try a different shipTo number and branch."

    Product API

    Get All Items – Delta Load Functionality

    We’ve added a product catalog delta load feature that significantly reduces catalog processing time by retrieving only items that have been updated since a provided date. Use the “sinceLastModifiedDateTime” query parameter with ISO 8601 value format of “YYYY-MM-DDThh:mm:ss.000Z” to specify the datetime from which you would like to receive the most recent product catalog updates.

    The delta load feature uses the item “status” field to track changes, including items that may have been marked as “Inactive” since your last catalog sync. While the full catalog ingest only returns “Active” items, the delta load feature will return both “Active” and “Inactive” items to account for any items that have been removed from the catalog.

    Important: You must filter out “Inactive” items before displaying results to your users.

    Get All Items – marketingDescription” Now Available

    Get All Items now returns an extended description of select items in the new “marketingDescription” field. If a description is not available for an item, the value returned will be null.

  • 2025.05.22 Update

    Due to some exciting changes in our development group, we will not be releasing any new features this week. The next planned production release will be 2025.05.27 after business hours.

  • 2025.05.12 Release

    Now Available

    Order API

    Place Order – Validation for Unique requestId in Multi-Order Requests

    The Place Order endpoint has improved validation of duplicate requestId values.

    New error message for duplicate requestId values:

    202 ACCEPTED
    ---
    {
        "request": {
            "batchId": "B11403496",
            "recievedTime": "2025-05-13T12:35:53.447",
            "ordersReceived": 2,
            "ordersFailed": 1,
            "ordersSucceded": 1
        },
        "orders": [
            {
                "requestId": "123",
                "confirmationNumber": "C10-12768726",
                "message": "Ordered successfully"
            },
            {
                "requestId": "123",
                "confirmationNumber": null,
                "message": "Error: requestId must be unique"
            }
        ]
    }

    Account API

    Get Ship-To – homeBranch flag for Ship-To Account Branches

    The flag “homeBranch” is now available on each branch in the “branches” array of the Get Ship-To response.

    "branches": [
        {
            "homeBranch": false,
            "number": "300",
            "name": "ABC Supply - Bryan, TX",
            "storefront": "abc",
            "status": "active",
            "type": "Branch",
            "links": {
                "self": "https://api3-sb.abcsupply.com/int-partners-location/api/location/v1/branches/300"
            }
        },
    ...
    ]

    Product API

    Get All Items / Get Item / Search Items – Removed Extra UOM Types

    Product API endpoints now return a limited set of UOM types: “stocking”, “costing”, and “estimate”. The most commonly used UOM type for pricing and ordering is “stocking”; however, “costing” and “estimate” will provide additional UOMs that some customers may find valuable.

    Get All Items / Get Item / Search Items – Enhanced “status” Field

    The “status” field in the Product API endpoints has been enhanced to combine several additional flags that determine whether or not an item should be offered to customers via the APIs. If an item has a status of “Inactive”, it should not be made available to customers as these items are not sellable via the APIs. If the item has a status of “Active”, it is sellable and can be included in your integration’s product offerings. All items should return as “status”: “Active” for these endpoints except the case noted in the Upcoming Release notes below (Get All Items – Enhanced Delta Load Functionality).

    Get All Items – Improved Ordering of Items in Response

    Get All Items responses are now ordered by a new key that allows for more reliable item ordering and better performance.

    Upcoming Release2025.05.19

    Product API

    Get All Items – New Field “marketingDescription” Now Available

    We’ve added a new field called “marketingDescription” to the item schema that returns the marketing copy used on our customer platform. This is available for most items, but may return as an empty string when not available from our item management system. Currently, this text contains new line characters (“\n”) but we will be removing those in another upcoming release.

    Get All Items – Enhanced Delta Load Functionality

    Get All Items will be able to return only items that have been updated since the datetime provided in an optional query parameter called “sinceLastModifiedDateTime” with ISO 8601 value format of “YYYY-MM-DDThh:mm:ssZ”. The request will return all updated items regardless of “status” value of “Active” or “Inactive”. This allows integrators to account for any items that may have changed from “Active” to “Inactive”. The “Inactive” items should be filtered out of the items shown to customers in your integration.