cartTaxes

This app commands allows users to add or retrieve tax into/from the cart.

GET

Description:
Get the tax info such as name of tax and tax amount from cart

Request Body:

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

Response Body:

{
    command: 'cartTaxes',
    method: 'get',
    version: '1.0',
    status_code: 200,
    error: null,
    tax_name: 'Ontario HST/GST', 
    amount: 13.00,
    amount_type: '$'
}

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

POST

Description:
Add tax into cart with info such as name of tax and tax amount.

Request Body:

{
    command: 'cartTaxes',
    method: 'post',
    version: '1.0',
    tax_name: 'Ontario HST/GST',
    amount: 13.00,
    amount_type: '$'
}

Response Body:

{
    command: 'cartTaxes',
    method: 'post',
    version: '1.0',
    status_code: 200,
    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

tax_name

string

Name of tax

null

1

amount

float, 2 decimal places

Amount of tax

null

1

amount_type

string

Amount type

'$', '%'

1


Did this page help you?