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
Getting Started
Introduction
Welcome to ABC Supply APIs, a powerful way to connect your platform of choice with your customer account, product, pricing, and order workflows with ABC Supply. The following information will help you get familiar with the API ecosystem and move quickly to production with your integration.
Before You Begin
The ABC Supply APIs expose critical customer data to enable our customers to choose the tools that work best for their business. While data is a powerful resource, we also must do our due diligence to ensure it is used appropriately and in line with our business model and philosphies. Prohibited uses of the ABC Supply APIs include but are not limited to the following:
- Direct price comparison tools across competitors or markets
- Material reselling or redistribution platforms
- Packaging or selling of product or pricing data for market analysis or intelligence
- Sublicensing of APIs for use by a third party
- Engaging in token pooling or any other form of fraudulent use or token misuse
Prior to accessing the ABC Supply APIs in our developer portal, you will be required to agree to our API Terms of Use, which cover the prohibited use cases in more detail. If you have any questions about accepted or prohibited uses of the ABC Supply APIs, please contact API Support.
To assist you with building the best integration possible, we have compiled the API Overview page as a valuable reference to guide your integration design. The API Overview covers all the critical concepts in ABC Supply’s business and data models to consider as you architect your user workflows. Please review this information before integrating, and keep it handy as a reference as you integrate.
What Type of Integrator Are You?
ABC Supply APIs have two different models of use, depending on the integration type: “Individual Business” and “Third-Party Aggregator”. You integration type will determine how your integration functions and the type of data to which you will have access.
Individual Business
This integration type is for a single ABC Supply customer who is using the ABC Supply APIs solely for their business. Integrations of this type are commonly for custom, in-house CRMs or integrations to an internal tool like Zapier, NetSuite, or HubSpot. These integrations connect to one or several ABC Supply customer accounts to which the integration has direct access and can only access those accounts specified within the integration’s configuration. Individual Business integrations use the Client Credential authorization method.
If you are an ABC Supply customer building an integration for only your company to use and do not wish to require a user to log into the integration to access data, then choose this integration type.
Head to Individual Business Integration Track to get started!
Third-Party Aggregator
This integration type is for any third-party commercial platforms that seek to offer our mutual customers a means to access their account-specific ABC Supply data. Third-Party Aggregator integrations allow limited use of the APIs without a user present (Location API, Product API, Notification API) using the Client Credential authorization method. Customer pricing, ordering, and invoice data require a user to connect their myABCSupply user account and be present at the time of the request, with the exception of our Order Status and Invoice Status webhooks. This data requires the use of the OAuth 2.0 Authorization Code Flow (with optional PKCE) authorization method.
If you are integrating a commercial platform that will be offered to ABC Supply customers, then choose this integration type.
Head to Third-Partner Aggregator Integration Track to get started!