Customers

This is a command for manipulating customer records. This command will not be available on the POS side.

GET

Description:
Retrieves all customer records from Oliver. Oliver will respond with a list of customers with email, name, address and notes.

Request Body:

{
    command: 'Customers',
    method: 'get',
    version: '1.0'    
}

Response Body:

{
    command: 'Customers',
    method: 'get',
    version: '1.0',
    status: 200,
    error: null
    data :[
        {
            email: '[email protected]',
            first_name: 'Rosa', 
            last_name: 'Diaz', 
            address_line_one: null, 
            address_line_two: null , 
            country: null , 
            state: null, 
            city: null, 
            postal_code: null ,
            notes: null 
        },
        {
            email: '[email protected]',
            first_name: 'Gina', 
            last_name: 'Linetti', 
            address_line_one: 'Piazza Garibaldi 45',  
            address_line_two: null,
            country: 'Italy',
            state: 'Udine', 
            city: 'Tricesimo', 
            postal_code: null ,
            notes: null 
        },
        {
            email: '[email protected]',
            first_name: 'Jake',
            last_name: 'Peralta',
            address_line_one: '153 East 67th Street',
            address_line_two: null ,
            country: 'USA',
            state: 'New York',
            city: 'Brooklyn',
            postal_code: '10065',
            notes: null
        }
    ]
}

Parameters:

Attribute Name

Attribute Type

Description

Required (binary)

command

string

High level command name to interact with Oliver

1

method

string

These correspond to create, read, update, and delete (or CRUD) operations

1

version

string

The version of the command used

1

POST

Description:
Creates and adds a new customer with email, name, address and notes into Oliver.

Request Body:

{
    command: 'Customers',
    method: 'post',
    version: '1.0',
    data: {
       email: '[email protected]', 
       first_name: 'Rosa', 
       last_name: 'Diaz', 
       address_line_one: null, 
       address_line_two: null , 
       country: null , 
       state: null, 
       city: null, 
       postal_code: null , 
       notes: null 
    }
}

Response Body:

{
    command: 'Customers',
    method: 'post',
    version: '1.0',
    status: 200,
    error: null
}

Parameters:

Attribute Name

Attribute Type

Description

Required (binary)

command

string

High level command name to interact with Oliver

1

method

string

These correspond to create, read, update, and delete (or CRUD) operations

1

version

string

The version of the command used

1

email

string

Customer email address

1

first_name

string

First name of customer

0

last_name

string

Last name of customer

0

address_line_one

string

Address line one of customer

0

address_line_two

string

Address line two of customer

0

country

string

Country of customer

0

state

string

State of customer

0

city

string

City of customer

0

postal_code

string

Postal code of customer

0

notes

string

Customer notes

0

PUT

Description:
Edit information of an existing customer in Oliver.

Request Body:

{
    command: 'Customers',
    method: 'put',
    version: '1.0',
    email: '[email protected]',
    data: {
        email: '[email protected]', 
        first_name: 'Rosie', 
        last_name: 'Hernandez', 
        address_line_one: '183 Drake St 708', 
        address_line_two: null , 
        country: 'Canada', 
        state: 'British Columbia', 
        city: 'Vancouver', 
        postal_code: null , 
        notes: null 
    }
}

Response Body:

{
    command: 'Customers',
    method: 'put',
    version: '1.0',
    status: 200,
    error: null
}

Parameters:

Attribute Name

Attribute Type

Description

Required (binary)

command

string

High level command name to interact with Oliver

1

method

string

These correspond to create, read, update, and delete (or CRUD) operations

1

version

string

The version of the command used

1

email

string

Customer email address

1

first_name

string

First name of customer

0

last_name

string

Last name of customer

0

address_line_one

string

Address line one of customer

0

address_line_two

string

Address line two of customer

0

country

string

Country of customer

0

state

string

State of customer

0

city

string

City of customer

0

postal_code

string

Postal code of customer

0

notes

string

Customer notes

0

DELETE

Description:
Deletes an existing customer from Oliver.

Request Body:

{
    command: 'Customers',
    method: 'delete',
    version: '1.0',
    email: '[email protected]'
}

Response Body:

{
    command: 'Customers',
    method: 'delete',
    version: '1.0',
    status: 200,
    error: null
}

Parameters:

Attribute Name

Attribute Type

Description

Required (binary)

command

string

High level command name to interact with Oliver

1

method

string

These correspond to create, read, update, and delete (or CRUD) operations

1

version

string

The version of the command used

1

email

string

Customer email

1


Did this page help you?