Get Customer Children
Retrieves the child customer records for the specified customer.
Request
Request-Line
GET /sfd/v2.0/customers/{parentId}/childCustomers HTTP/1.1
Request Parameters
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
parentId | Integer | Mandatory | Parent customer ID. |
Response
Response Body
Parameter | Type | Required | Description |
---|---|---|---|
Array | Mandatory | Array of Customer. |
Object: Customer
Property name | Type | Required | Description |
---|---|---|---|
id | Integer | Mandatory | Unique identifier of the customer record. |
name | String | Mandatory | Name of the customer. |
parentId | Integer | Mandatory | Parent ID. |
type | Short | Mandatory | Customer type. 1 - Partner. 2 - Customer. |
partnership | Short | Optional | Ignore this field. |
region | String | Optional | Region. |
industry | String | Optional | Industry. |
Status Codes, Error Codes and Error Messages
Status Code | Error Code | Error Message |
---|---|---|
400 | CustomerId.Invalid | CustomerId is empty or invalid. |
Examples
Get Customer Children
Request
GET /sfd/v2.0/customers/1/childCustomers HTTP/1.1
Successful Response Body
[
{
"id": 2,
"name": "Example Corp",
"parentId": 1,
"type": 1,
"region": "SG",
"industry": "Advertising & Marketing"
},
{
"id": 30002,
"name": "Foo Internet Inc.",
"parentId": 1,
"type": 1,
"region": "SG",
"industry": "Advertising & Marketing"
}
]