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 Contacts endpoint returns ship-to account contact information, such as name, function, telephone numbers, and email addresses. You can specify the ship-to account number in the resource URL.
Account API
Get Ship-To Contacts
GET /shiptos/{shipToNumber}/contacts
Get account contacts by ship-to account number
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the account.read scope.
Request
Example Request
Get Ship-To Contacts request for a provided ship-to account number
URI Parameter
The URI parameter “{shipToNumber}” is the ship-to account number.
GET /api/account/v1/shiptos/281468/contacts HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN> Response
Example Response
Get Ship-To Contacts response payload for a provided ship-to account number
[
{
"id": 1,
"firstName": "Jack",
"lastName": "Smith",
"functionCode": "IC",
"functionDescription": "Information Contact",
"phone": {
"number": "+13043651700",
"type": "MOBILE",
"ext": ""
},
"emails": {
"email": "[email protected]",
"type": "PRIMARY"
}
},
{
"id": 2,
"firstName": "Jack",
"lastName": "Smith",
"functionCode": "IC",
"functionDescription": "Information Contact",
"phone": {
"number": "+13043651710",
"type": "WORK",
"ext": ""
},
"emails": {
"email": "[email protected]",
"type": "PRIMARY"
}
},
{
"id": 3,
"firstName": "Eric",
"lastName": "Mullens",
"functionCode": "SR",
"functionDescription": "Sales Representative",
"phones": {
"number": "+13043651710",
"type": "WORK",
"ext": "1234"
},
"emails": {
"email": "[email protected]",
"type": "PRIMARY"
}
}
]Name
Type
Description
id
integer
The unique identification number of the Ship-to account contact.
firstName
string
The first name of the Ship-to contact.
lastName
string
The last name of the Ship-to contact.
functionCode
string
The short code representing the role or function of the Ship-to contact (e.g., “IC”: Information Contact, “DC” : Delivery Contact, “DI”: Delivery Instructions Contact, “SO”: Service Order Writer, “OC”: Order Contact/Taker, “SM”: Order Submitting Contact, “AP”: Accounts Payable/Bill-To Contact).
functionDescription
string
The description of the role or function of the Ship-to contact.
phones
array
The list of the phone numbers associated with the Ship-to contact.
phones[].number
string
The phone number of the Ship-to contact.
phones[].type
string
The type of the phone number (e.g., “MOBILE”, “WORK”, “FAX”).
phones[].ext
string
This is the phone number extension, if applicable.
emails
array
The list of the email addresses associated with the Ship-to contact.
emails[].email
string
The email address of the Ship-to contact.
emails[].type
string
The type of the email address (e.g., “PRIMARY”, “SECONDARY”).
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 ship-to account number. Please verify that the account number is valid and the account is enrolled with the current integration.