Account API
Access your account information, including account hierarchies, billing and shipping addresses, contacts and other key customer attributes. The Account API lets you update jobsite contacts, so key team members receive pertinent delivery updates.
The Search Accounts endpoint returns sold-to, bill-to, and ship-to account numbers, names, status, and other key account information. With this endpoint, you can search for account details using various parameters, such as branch, account number, account name, etc. The request may also specify pagination options.
Account API
Search Accounts
POST /search/accounts
Search sold-to, bill-to, and ship-to accounts
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the account.read scope.
Request
Name
Type
Description
filters
array
An array that includes all filter conditions used to search for accounts. Multiple sets of key/value conditions can be included.
filters[].key
string
This defines the type of filter being applied (e.g., “accountType”, “branch.number”, “name”, “address.state”, “shipTo.number”, “billTo.number”, “soldTo.number”).
filters[].condition
enum
This specifies the condition used for filtering, (e.g., “equals”, “contains”, “in”).
filters[].values
array
The values used to filter the data based on the filter[].key.
pagination
object
Object containing the pagination details for the search results.
pagination.itemsPerPage
integer
This is the number of items displayed per page in the search results. Defaults to 50 items per page.
pagination.pageNumber
integer
This is the current page number being displayed in the search results. Defaults to page 1.
Example Request
Search accounts by branch.
POST /api/account/v1/search/accounts HTTP/1.1
Host: partner.abcsupply.com
Authorization: Bearer <TOKEN>
{ "filters": [
{
"key": "branches.number",
"condition": "equals",
"values": ["409"]
}
],
"pagination": {
"itemsPerPage": 20,
"pageNumber": 2
}
}Response
Example Response
Search accounts by branch.
{
"pagination": {
"itemsPerPage": 20,
"pageNumber": 2,
"totalPages": 5,
"totalItems": 100
},
"soldTos": [
{
"name": "ABC Construction",
"number": "12345678",
"status": "active",
"address": {
"line1": "1 ABC Parkway",
"line2": "",
"line3": "",
"city": " Beloit",
"state": "WI",
"postal": "53511",
"country": "USA"
},
"branches": [
{
"number": "409",
"name": "ABC Supply - Hyattsville, UT",
"storefront": "ABC",
"status": "active",
"type": "PRIMARY",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/409"
}
},
{
"number": "030",
"name": "ABC Supply - Aurora, IL",
"storefront": "ABC",
"status": "active",
"type": "APPROVED",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/030"
}
}
]
}
],
"billTos": [
{
"name": "ABC Billing Center",
"number": "12345678-1",
"status": "active",
"address": {
"line1": "1 ABC Parkway",
"line2": "Billing Center Building",
"line3": "",
"city": " Beloit",
"state": "WI",
"postal": "53511",
"country": "USA"
},
"billingInstructions": [
{
"code": "N",
"description": "Do not print on the invoice"
}
],
"branches": [
{
"number": "409",
"name": "ABC Supply - Hyattsville, UT",
"storefront": "ABC",
"status": "active",
"type": "PRIMARY",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/409"
}
},
{
"number": "030",
"name": "ABC Supply - Aurora, IL",
"storefront": "ABC",
"status": "active",
"type": "APPROVED",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/030"
}
}
],
"soldTo": {
"name": "ABC Construction",
"number": "12345678",
"status": "active",
"links": {
"self": "https://partners.abcsupply.com/mock/account/v1/soldtos/12345678"
}
}
}
],
"shipTos": [
{
"name": "ABC Construction Training Center",
"number": "12345678-100",
"status": "Active",
"address": {
"line1": "1 ABC Parkway",
"line2": "Training Center Bulding",
"line3": "",
"city": " Beloit",
"state": "WI",
"postal": "53511",
"country": "USA"
},
"contacts": {
"links": {
"self": "https://partners.abcsupply.com/mock/account/v1/shiptos/12345678-100/contacts"
}
},
"branches": [
{
"number": "409",
"name": "ABC Supply - Hyattsville, UT",
"storefront": "ABC",
"status": "active",
"type": "PRIMARY",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/409"
}
},
{
"number": "030",
"name": "ABC Supply - Aurora, IL",
"storefront": "ABC",
"status": "active",
"type": "APPROVED",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/030"
}
}
],
"paymentTerms": {
"code": "COD",
"description": "CASH ON DELIVER"
},
"tax": {
"exemptCode": "T",
"taxQualifiers": [
{
"locationTypeCode": "STATE",
"locationCode": "WV"
}
]
},
"billTo": {
"name": "ABC Billing Center",
"number": "12345678-1",
"status": "active",
"links": {
"self": "https://partners.abcsupply.com/mock/account/v1/billtos/12345678-1"
}
},
"soldTo": {
"name": "ABC Construction",
"number": "12345678",
"status": "active",
"links": {
"self": "https://partners.abcsupply.com/mock/account/v1/soldtos/12345678"
}
}
}
]
}Name
Type
Description
pagination
object
The object describing the pagination of the response.
pagination.itemsPerPage
integer
The number of items per page in the response.
pagination.pageNumber
integer
The current page number of the response.
pagination.totalPages
integer
The total number of pages in the response.
pagination.totaItems
integer
The total number of items in the response.
soldTos
array
The list of information about the Sold-to account.
soldTos[].name
string
The name of the Sold-to account.
soldTos[].number
string
The unique identification number for the Sold-to account.
soldTos[].status
string
The current status of the Sold-to account (e.g., “active”, “inactive”).
soldTo[].address
object
The object describing the address of the Sold-to account.
soldTo[].address.line1
string
The first line of the Sold-to account address, usually including the street number and name.
soldTo[].address.line2
string
The second line of the Sold-to account address, which may include additional information like building numbers.
soldTo[].address.line3
string
The third line of the Sold-to account address, often used for more specific location information or additional directions.
soldTo[].address.city
string
The city of the Sold-to account address.
soldTo[].address.state
string
The state of the Sold-to account address.
soldTo[].address.postal
string
The zip code of the Sold-to account address.
soldTo[].address.country
string
The country of the Sold-to account address.
soldTos[].branches
array
The list of information about the Sold-to ABC Supply branches.
soldTos[].branches[].number
string
The ABC Supply branch number.
soldTos[].branches[].name
string
The name of the branch.
soldTos[].branches[].storefront
string
The physical storefront or location of the branch (e.g., “ABC”).
soldTos[].branches[].status
string
The current operational status of the branch (e.g., “active”, “inactive”).
soldTos[].branches[].type
string
The specific type of the branch (e.g., “PRIMARY”, “APPROVED”).
soldTos[].branches[].links
object
The object describing the link to the ABC Supply branch details.
soldTos[].branches[].links.self
string
The URL of the self-referencing link to the branch details.
Name
Type
Description
billTos
array
This object contains the Bill-to account information.
billTos[].name
string
The name of the Bill-to account.
billTos[].number
string
The unique identification number for the Bill-to account.
billTos[].status
string
The current status of the Bill-to account (e.g., “active”, “inactive”).
billTos[].address
object
The object describing the address of the Bill-to account
billTos[].address.line1
string
The first line of the Bill-to account address, usually including the street number and name.
billTos[].address.line2
string
The second line of the Bill-to account address, which may include additional information like building numbers.
billTos[].address.line3
string
The third line of the Bill-to account address, often used for more specific location information or additional directions.
billTos[].address.city
string
The city of the Bill-to account address.
billTos[].address.state
string
The state of the Bill-to account address.
billTos[].address.postal
string
The zip code of the Bill-to account address.
billTos[].address.country
string
The country of the Bill-to account address.
billTos[].billingInstruction
array
The object describing the billing instructions for the account.
billTos[].billingInstruction[].code
string
The code for the billing instruction.
billTos[].billingInstruction[].description
string
The description of the billing instruction.
billTos[].branches
array
The list of information about the Bill-to ABC Supply branches.
billTos[].branches[].number
string
The ABC Supply branch number.
billTos[].branches[].name
string
The name of the branch.
billTos[].branches[].storefront
string
The physical storefront or location of the branch (e.g., “ABC”).
billTos[].branches[].status
string
The current operational status of the branch (e.g., “active”, “inactive”).
billTos[].branches[].type
string
The specific type of the branch (e.g., “PRIMARY”, “APPROVED”).
billTos[].branches[].links
object
The object describing the link to the ABC Supply branch details.
billTos[].branches[].links.self
string
The URL of the self-referencing link to the branch details.
billTos[].soldTo
object
The object describing the Sold-to account information related to the Bill-to account.
billTos[].soldTo.number
string
The unique identification number for the Sold-to account.
billTos[].soldTo.name
string
The name of the Sold-to account.
billTos[].soldTo.status
string
The current status of the Sold-to account (e.g., “active”, “inactive”).
billTos[].soldTo.links
object
The object describing the link to the Sold-to account details.
billTos[].soldTo.links.self
string
The URL of the self-referencing link to the Sold-to account details.
Name
Type
Description
shipTos
array
The list of information about the Ship-to account.
shipTos[].name
string
The name of the Ship-to account.
shipTos[].number
string
The unique identification number for the Ship-to account.
shipTos[].status
string
The current status of the Ship-to account (e.g., “active”, “inactive”).
shipTos[].address
object
The object describing the address of the Ship-to account.
shipTos[].address.line1
string
The first line of the Ship-to account address, usually including the street number and name.
shipTos[].address.line2
string
The second line of the Ship-to account address, which may include additional information like building numbers.
shipTos[].address.line3
string
The third line of the Ship-to account address, often used for more specific location information or additional directions.
shipTos[].address.city
string
The city of the Ship-to account address.
shipTos[].address.state
string
The state of the Ship-to account address.
shipTos[].address.postal
string
The zip code of the Ship-to account address.
shipTos[].address.country
string
The country of the Ship-to account address.
shipTos[].contacts
object
The object describing the contact information for the Ship-to account.
shipTos[].contacts.links
object
The object describing the self-referencing link to the Ship-to account contact details.
shipTos[].contacts.links.self
string
The URL of the self-referencing link to the Ship-to account contact details.
shipTos[].branches
array
The list of information about the Ship-to ABC Supply branches.
shipTos[].branches[].number
string
The ABC Supply branch number.
shipTos[].branches[].name
string
The name of the branch.
shipTos[].branches[].storefront
string
The physical storefront or location of the branch (e.g., “ABC”).
shipTos[].branches[].status
string
The current operational status of the branch (e.g., “active”, “inactive”).
shipTos[].branches[].type
string
The specific type of the branch (e.g., “PRIMARY”, “APPROVED”).
shipTos[].branches[].links
object
The object describing the link to the branch details.
shipTos[].branches[].links.self
string
The URL of the self-referencing link to the branch details.
shipTos[].paymentTerms
object
The object describing the payment terms for the Ship-to account.
Payment Terms information will be available in a future release of the ABC Supply API.
shipTos[].paymentTerms.code
string
The payment term code (e.g., “COD”).
Payment Terms information will be available in a future release of the ABC Supply API.
shipTos[].paymentTerms.description
string
The full description of the payment term (e.g., “CASH ON DELIVER”).
Payment Terms information will be available in a future release of the ABC Supply API.
shipTos[].tax
object
The object describing the tax exemption and qualifications for the Ship-to account.
Tax information will be available in a future release of the ABC Supply API.
shipTos[].tax.exemptCode
string
The tax exemption code (e.g., “T”).
Tax information will be available in a future release of the ABC Supply API.
shipTos[].tax.taxQualifiers
array
The list of the tax qualifiers for the Ship-to account.
Tax information will be available in a future release of the ABC Supply API.
shipTos[].tax.taxQualifiers[].locationTypeCode
string
The location type code for the tax qualifier (e.g., “STATE”).
Tax information will be available in a future release of the ABC Supply API.
shipTos[].tax.taxQualifiers[].locationCode
string
The location code for the tax qualifier (e.g., “WV”).
Tax information will be available in a future release of the ABC Supply API.
shipTos[].billTo
object
The object describing the Bill-to account information of the Ship-to account.
shipTos[].billTo.number
string
The unique identification number for the Bill-to account.
shipTos[].billTo.name
string
The name of the Bill-to account.
shipTos[].billTo.status
string
The current status of the Bill-to account (e.g., “active”, “inactive”).
shipTos[].billTo.links
object
The object describing the link to the Bill-to account details.
shipTos[].billTo.links.self
string
The URL of the self-referencing link to the Bill-to account details.
shipTos[].soldTo
object
The object describing the Sold-to account information of the Ship-to account.
shipTos[].soldTo.number
string
The unique identification number for the Sold-to account.
shipTos[].soldTo.name
string
The name of the Sold-to account.
shipTos[].soldTo.status
string
The current status of the Sold-to account (e.g. “active”, “inactive”).
shipTos[].soldTo.links
object
The object describing the link to the Sold-to account details.
shipTos[].soldTo.links.self
string
The URL of the self-referencing link to the Sold-to account details.
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.
Additional Examples
Example Request
Search Sold-to-accounts by state
POST /api/account/v1/search/accounts HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>
{ "filters": [
{
"key": "accountType",
"condition": "equals",
"values": ["Sold-to"]
},
{
"key": "address.state",
"condition": "equals",
"values": ["IL"]
}
],
"pagination": {
"itemsPerPage": 20,
"pageNumber": 2
}
}Example Request
Search accounts by name
POST /api/account/v1/search/accounts HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>
{ "filters": [
{
"key": "name",
"condition": "contains",
"values": ["Construction"]
}
],
"pagination": {
"itemsPerPage": 20,
"pageNumber": 2
}
}Example Request
Search Ship-to Accounts by Branch
POST /api/account/v1/search/accounts HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>
{ "filters": [
{
"key": "accountType",
"condition": "equals",
"values": ["Ship-To"]
},
{
"key": "branchNumber",
"condition": "equals",
"values": ["609"]
}
],
"pagination": {
"itemsPerPage": 20,
"pageNumber": 2
}
}Example Request
Search Ship-to accounts by Ship-to Numbers
POST /api/account/v1/search/accounts HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>
{ "filters": [
{
"key": "accountType",
"condition": "equals",
"values": ["Ship-To"]
},
{
"key": "shipToNumber",
"condition": "in",
"values": ["21355", "21356"]
}
],
"pagination": {
"itemsPerPage": 20,
"pageNumber": 2
}
}