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 Ship-To endpoint returns ship-to account information, such as name, number, addresses, default branches, and related bill-to and sold-to account information. You can specify the ship-to account number in the resource URL.
Account API
Get Ship-To
GET /shiptos/{shipToNumber}
Get ship-to account details by ship-to account number
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the account.read scope.
Request
Example Request
Sample request for a given ship-to.
URI Parameter
The URI parameter “{shipToNumber}” is the ship-to account number.
GET /api/account/v1/shiptos/281468 HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN> Response
Example Response
Sample response for an account requested by ship-to
{
"shipTo": {
"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/api/accounts/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/api/accounts/v1/billtos/12345678-1"
}
},
"soldTo": {
"number": "12345678",
"name": "ABC CONSTRUCTION",
"status": "active",
"links": {
"self": "https://partners.abcsupply.com/api/accounts/v1/soldtos/12345678"
}
}
}
}Name
Type
Description
shipTo
array
The object describing the Ship-to account information.
shipTo.name
string
The name of the Ship-to account.
shipTo.number
string
The unique identification number of the Ship-to account.
shipTo.status
string
The current status of the Ship-to account (e.g., “active”, “inactive”).
shipTo.address
object
The object describing the Ship-to account address.
shipTo.address.line1
string
The first line of the Ship-to address, usually including the street number and name.
shipTo.address.line2
string
The second line of the Ship-to address, usually including the street number and name.
shipTo.address.line3
string
The third line of the Ship-to address, usually including the street number and name.
shipTo.address.city
string
The city of the Ship-to account.
shipTo.address.state
string
The state of the Ship-to account.
shipTo.address.postal
string
The zip code of the Ship-to account.
shipTo.address.country
string
The country of the Ship-to account.
shipTo.contacts
string
The list of the contact information for the Ship-to account.
shipTo.contacts[].links
object
This object describing the self-referencing link to the Ship-to account contact details.
shipTo.contacts[].links.self
string
The URL of the self-referencing link to the Ship-to account contact details.
shipTo.branches
array
The list of information about the Ship-to ABC Supply branches.
shipTo.branches[].number
string
The ABC Supply branch number.
shipTo.branches[].name
string
The name of the branch.
shipTo.branches[].storefront
object
The physical storefront or location of the branch (e.g. “ABC”).
shipTo.branches[].status
string
The current operational status of the branch (e.g. “active”, inactive).
shipTo.branches[].type
string
The specific type of the branch (e.g., “PRIMARY”, “APPROVED”).
shipTo.branches[].links
object
The object describing the link to the ABC Supply branch details.
shipTo.branches[].links.self
string
The URL of the self-referencing link to the branch details.
shipTo.paymentTerms
object
The object describing the payment terms for the account. Payment Terms information will be available in a future release of the ABC Supply API.
shipTo.paymentTerms.code
string
Tthe payment term code (e.g. “COD”). Payment Terms information will be available in a future release of the ABC Supply API.
shipTo.paymentTerms.description
string
The 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.
shipTo.tax
object
The object describing information about the tax exemption and qualifications for the account. Tax information will be available in a future release of the ABC Supply API.
shipTo.tax.exemptCode
string
The tax exemption code for the account (e.g. “T”). Tax information will be available in a future release of the ABC Supply API.
shipTo.tax.taxQualifiers
array
The list of the tax qualifiers for the account. Tax information will be available in a future release of the ABC Supply API.
shipTo.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.
shipTo.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.
shipTo.billTo
object
The object describing the Bill-to account information.
shipTo.billTo.number
string
The unique identification number of the Bill-to account.
shipTo.billTo.name
string
The name of the Bill-to account.
shipTo.billTo.status
string
The current status of the Bill-to account (e.g., “active”, “inactive”).
shipTo.billTo.links
object
The object describing the link to the Bill-to account details.
shipTo.billTo.links.self
string
The URL of the self-referencing link to the Bill-to account details.
shipTo.soldTo
object
The object describing the Sold-to account information.
shipTo.soldTo.number
string
The unique identification number of the Sold-to account.
shipTo.soldTo.name
string
The name of the Sold-to account.
shipTo.soldTo.status
string
The current status of the Sold-to account (e.g., “active”, “inactive”).
shipTo.soldTo.links
object
The object describing the link to the Sold-to account details.
shipTo.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.