Gets an account.
Name | Description | Additional information |
---|---|---|
accountId | The ID of the account. |
Define this parameter in the request URI. |
Name | Description | Usage |
---|---|---|
accountType | This will retrieve the related account type. | GET accounts/{accountId}?expand=accounttype |
addresses | This will retrieve the related list of addresses. | GET accounts/{accountId}?expand=addresses |
orders | This will retrieve the related list of orders. | GET accounts/{accountId}?expand=orders |
profiles | This will retrieve the related list of profiles. | GET accounts/{accountId}?expand=profiles |
referralcommissiontype | This will retrieve the related referral commission type. | GET accounts/{accountId}?expand=referralcommissiontype |
user | This will retrieve the related user. | GET accounts/{accountId}?expand=user |
userrolepermissions | This will retrieve the related user role permissions. | GET accounts/{accountId}?expand=userrolepermissions |
wishList | This will retrieve the related list of wish lists. | GET accounts/{accountId}?expand=wishlist |
If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.
{
"Account": {
"AccountId": 11521,
"AccountProfileCode": null,
"AccountType": {
"AccountTypeId": 0,
"AccountTypeName": "CUSTOMER"
},
"AccountTypeId": 0,
"Addresses": [],
"CompanyName": "Your Company",
"CreateDate": "2013-04-29T10:49:32.657",
"CreateUser": null,
"ReferralCommissionType": null,
"Custom1": null,
"Custom2": null,
"Custom3": null,
"Description": "Site Administrator Account",
"Email": "znodeadmin1@test.com",
"EmailOptIn": true,
"EnableCustomerPricing": false,
"UserEnableCustomerPricing": false,
"ExternalId": null,
"ChildExternalAccountId": null,
"UserExternalAccountId": null,
"GiftCardHistoryList": null,
"IsActive": true,
"Orders": [],
"ParentAccountId": null,
"ProfileId": 1,
"Profiles": [],
"ReferralAccountId": null,
"ReferralCommission": null,
"ReferralCommissionTypeId": null,
"ReferralStatus": null,
"Source": null,
"SubAccountLimit": null,
"TaxId": null,
"UpdateDate": "2013-09-21T11:59:19.74",
"UpdateUser": null,
"User": null,
"AddressModel": null,
"UserId": "8086a820-d3f6-4763-ae07-ce84ab85e2e7",
"WebServiceDownloadDate": null,
"Website": null,
"WishList": [],
"BaseUrl": null,
"IsUserInRole": false,
"UserName": null,
"RoleName": null,
"ErrorCode": null,
"FullName": null,
"PhoneNumber": null,
"FirstName": null,
"LastName": null,
"LoginName": null,
"ExternalAccountNum": null,
"StartDate": "0001-01-01T00:00:00",
"EndDate": "0001-01-01T00:00:00",
"PortalId": null,
"UserType": null,
"IsEmailSentFailed": false,
"IsSinglePageCheckoutUser": false,
"TrackingLink": null,
"CustomerPaymentGUID": null,
"B2BRoleName": null,
"CompanyId": 0,
"MaxBudget": null,
"DepartmentId": null,
"RoleId": null,
"EmailAddress": null,
"ParentCompanyName": null,
"UserRoleOperations": [],
"IsB2BAccount": false,
"ApprovalAccountId": null,
"UserRoleId": null,
"IsLockedOut": false,
"CoreBridgeAuthenticationServiceResponse": null,
"CesaControlAuthenticationResponse": null,
"DefaultLocationID": null,
"IsEmailVerified": false
},
"ErrorCode": null,
"ErrorMessage": null,
"StackTrace": null,
"AllowHtmlResponse": false,
"HasError": false,
"StringResponse": null
}