CustomerDetails
This app command retrieves information of a customer from Oliver using email as an identifier. Oliver will respond with the first and last name, email, address and notes associated with the customer.
GET
Description:
Retrieve information of a customer with email ‘[email protected]’ from Oliver
Request Body:
{
command: 'CustomerDetails',
method: 'get',
version: '1.0',
email: '[email protected]'
}
Response Body:
{
command: 'CustomerDetails',
method: 'get',
version: '1.0',
status: 200,
data: {
Id: 52,
first_name: 'Jake',
last_name: 'Peralta',
email: '[email protected]',
address_line_one: '153 East 67th Street',
address_line_two: null ,
country: 'USA',
state: 'New York',
city: 'Brooklyn',
postal_code: '10065',
phone_number: "7000000000",
notes: null
},
error: null
}
Parameters:
Attribute Name | Attribute Type | Description | Enum | Required (binary) |
---|---|---|---|---|
command | string | High level command name to interact with Oliver | null | 1 |
method | string | These correspond to create, read, update, and delete (or CRUD) operations | null | 1 |
version | string | The version of the command used | null | 1 |
string | Customer email address, must be unique | null | 1 |
Updated 7 months ago