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.
Get Sold-To endpoint returns sold-to account information, such as name, number, addresses, and default branches. You can specify the sold-to account number in the resource URL.
Account API
Get Sold-To
GET /soldtos/{soldToNumber}
Get sold-to account details by sold-to account number
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the account.read scope.
Request
Example Request
Get Sold-To request for a provided sold-to account number
URI Parameter
The URI parameter “{soldToNumber}” is the sold-to account number.
GET /api/account/v1/soldtos/12345678 HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>Response
Example Response
Get Sold-To response payload for a provided sold-to account number
{
"soldTo": {
"name": "ABC Construction",
"number": "12345678",
"status": "active",
"address": {
"line1": "1 ABC Parkway",
"line2": "Building 2",
"line3": "Dock 5",
"city": " Beloit",
"state": "WI",
"postal": "53511",
"country": "USA"
},
"branches": [
{
"number": "409",
"name": "ABC Supply 409",
"storefront": "abc",
"status": "active",
"type": "Branch",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/409"
}
},
{
"number": "030",
"name": "ABC Supply 030",
"storefront": "abc",
"status": "active",
"type": "Branch",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/030"
}
}
]
}
}Name
Type
Description
soldTo
object
The object describing information about the Sold-to account.
soldTo.name
string
The name of the Sold-to account.
soldTo.number
string
The unique identification number of the Sold-to account.
soldTo[].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.
soldTo.branches
array
The list of information about the Sold-to ABC Supply branches.
soldTo.branches[].number
string
The ABC Supply branch number.
soldTo.branches[].name
string
The name of the branch.
soldTo.branches[].storefront
string
The physical storefront or location of the branch (e.g., “abc”, “lw”).
soldTo.branches[].status
string
The current operational status of the branch (e.g., “active”, “inactive”).
soldTo.branches[].type
string
The specific type of the branch (e.g., “Branch”).
soldTo.branches[].links
object
The object describing the link to the ABC Supply branch details.
soldTo.branches[].links.self
string
The URL of the self-referencing link to the branch details.
HTTP Status Codes
Code
Status
Description
200
OK
The request and response were successfully sent.
400
Bad Request
Confirm the request body and parameters are formatted correctly.
403
Forbidden
The user does not have access to the provided sold-to account number. Please verify that the account number is valid and the account is enrolled with the current integration.