REST API for Oracle Commerce Cloud

searchContacts

get

/ccstore/v1/selfservice/contacts

Search contacts in the customer data master. Note : This endpoint is operational only when customer data sync is enabled.

Request

Supported Media Types

application/json

Query Parameters

includeB2BContactsOnly: boolean

If true, only B2B contacts are included in the results. If false, results include contacts of other profile types.

Default Value: true
includedRoles: string

This field determines if only organizational roles or all roles are to be returned for the member. Default value is 'organizationalRolesForCurrentOrganization'. Possible values are 'organizationalRolesForCurrentOrganization', 'allRolesForCurrentOrganization'.

Default Value: organizationalRolesForCurrentOrganization
keyword: string

The keyword used to search the contact
limit: integer

The maximum number of items to return.
offset: integer

Numeric offset of the first item returned.
q: string

Query string that filters the contacts and supports only eq operator.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : SearchContact_response

Type: object

Show Source

hasMore: boolean

Returns true if more resources are available on the server than the subset returned in current page.
items: array items

List of contacts.
limit: integer

The number of items to return.
links: array links

Links to pages
offset: integer

Index of the first element to return.
totalResults: integer

The total number of items.

{
    "properties":{
        "totalResults":{
            "description":"The total number of items.",
            "type":"integer"
        },
        "offset":{
            "description":"Index of the first element to return.",
            "type":"integer"
        },
        "hasMore":{
            "description":"Returns true if more resources are available on the server than the subset returned in current page.",
            "type":"boolean"
        },
        "limit":{
            "description":"The number of items to return.",
            "type":"integer"
        },
        "links":{
            "description":"Links to pages",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "items":{
            "description":"List of contacts.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "firstName":{
                        "description":"First name of a contact",
                        "type":"string"
                    },
                    "lastName":{
                        "description":"Last name of a contact",
                        "type":"string"
                    },
                    "phone":{
                        "description":"Phone number of a contact",
                        "type":"string"
                    },
                    "partyNumber":{
                        "description":"The PartyNumber of a account",
                        "type":"string"
                    },
                    "partyId":{
                        "description":"The party ID of a contact",
                        "type":"number"
                    },
                    "email":{
                        "description":"Email of a contact",
                        "type":"string"
                    },
                    "primaryAccountName":{
                        "description":"Name of primary account of a contact",
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "totalResults":1,
        "offset":0,
        "limit":1,
        "hasMore":false,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadminui/v1/selfservice/contacts?keyword=Laura&limit=1"
            },
            {
                "rel":"next",
                "href":"http://localhost:9080/ccadminui/v1/selfservice/contacts?keyword=Laura&limit=1&offset=1"
            }
        ],
        "items":[
            {
                "firstName":"Laura",
                "lastName":"Brown",
                "phone":"111-555-1111",
                "partyNumber":"CDRM_11111",
                "partyId":"100101114441",
                "email":"laurabrown@example.com",
                "primaryAccountName":"Oracle"
            }
        ]
    }
}

Example:

{
    "totalResults":1,
    "offset":0,
    "limit":1,
    "hasMore":false,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/selfservice/contacts?keyword=Laura&limit=1"
        },
        {
            "rel":"next",
            "href":"http://localhost:9080/ccadminui/v1/selfservice/contacts?keyword=Laura&limit=1&offset=1"
        }
    ],
    "items":[
        {
            "firstName":"Laura",
            "lastName":"Brown",
            "phone":"111-555-1111",
            "partyNumber":"CDRM_11111",
            "partyId":"100101114441",
            "email":"laurabrown@example.com",
            "primaryAccountName":"Oracle"
        }
    ]
}

Nested Schema : items

Type: array

List of contacts.

Show Source

Array of: object items

{
    "description":"List of contacts.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "firstName":{
                "description":"First name of a contact",
                "type":"string"
            },
            "lastName":{
                "description":"Last name of a contact",
                "type":"string"
            },
            "phone":{
                "description":"Phone number of a contact",
                "type":"string"
            },
            "partyNumber":{
                "description":"The PartyNumber of a account",
                "type":"string"
            },
            "partyId":{
                "description":"The party ID of a contact",
                "type":"number"
            },
            "email":{
                "description":"Email of a contact",
                "type":"string"
            },
            "primaryAccountName":{
                "description":"Name of primary account of a contact",
                "type":"string"
            }
        }
    }
}

Nested Schema : links

Type: array

Links to pages

Show Source

Array of: object items

{
    "description":"Links to pages",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Show Source

email: string

Email of a contact
firstName: string

First name of a contact
lastName: string

Last name of a contact
partyId: number

The party ID of a contact
partyNumber: string

The PartyNumber of a account
phone: string

Phone number of a contact
primaryAccountName: string

Name of primary account of a contact

{
    "type":"object",
    "properties":{
        "firstName":{
            "description":"First name of a contact",
            "type":"string"
        },
        "lastName":{
            "description":"Last name of a contact",
            "type":"string"
        },
        "phone":{
            "description":"Phone number of a contact",
            "type":"string"
        },
        "partyNumber":{
            "description":"The PartyNumber of a account",
            "type":"string"
        },
        "partyId":{
            "description":"The party ID of a contact",
            "type":"number"
        },
        "email":{
            "description":"Email of a contact",
            "type":"string"
        },
        "primaryAccountName":{
            "description":"Name of primary account of a contact",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

400 Response

When request payload is not correct or properties are missing.

Root Schema : errorModel400

Type: object

Show Source

errorCode: string

The CMS error code

Example: 80205
message: string

The HTTP error message

Example: Required properties are missing or invalid
status: string

The HTTP status code

Example: 400

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The CMS error code",
            "type":"string",
            "example":80205
        },
        "message":{
            "description":"The HTTP error message",
            "type":"string",
            "example":"Required properties are missing or invalid"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string",
            "example":400
        }
    }
}

Default Response

The default error response. The following are the internal error codes thrown by this API: |Error Code|Description| |------------------|------------------| |58001|Internal server error.| |58002|JSON related error.| |58003|Invalid configuration error.|

Root Schema : errorModel

Type: object

Show Source

devMessage: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
errors: array errors

An optional list of errors if multiple errors were encountered
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: string

The HTTP status code
type: string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: string

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}