merchantapi package

Submodules

merchantapi.abstract module

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

$Id: abstract.py 77675 2019-08-29 21:03:50Z gidriss $

class merchantapi.abstract.Client

Bases: object

abstract generate_auth_header(data: str) → str

Generates the authentication header value.

Parameters

data – str

Returns

str

abstract get_api_token()

Get the api token used to authenticate the request.

Returns

str

abstract get_endpoint()

Get the API endpoint URL.

Returns

str

abstract get_signing_key()

Get the signing key used to sign requests. Base64 encoded.

Returns

str

abstract send(request: merchantapi.abstract.Request) → merchantapi.abstract.Response

Send a Request object with callback.

Parameters

request – Request

Raises

Exception –

Returns

Response

class merchantapi.abstract.Model(data: dict = None)

Bases: dict

get_field(name: str, default=None)

Get a field value.

Parameters

• name – str

• default – mixed

Returns

mixed

has_field(name: str)

Check if a field is defined.

Parameters

name – str

Returns

bool

set_field(name: str, value)

Set a field value.

Parameters

• name – str

• value – mixed

Returns

Model

to_dict()

Reduce the model to a dict.

class merchantapi.abstract.Request(client: merchantapi.abstract.Client = None)

Bases: object

SCOPE_DOMAIN = 2

SCOPE_STORE = 1

create_response(data) → merchantapi.abstract.Response

Override this method to create a response for this request.

Parameters

data – dict

Returns

Response

get_client() → merchantapi.abstract.Client

Return the assigned client.

Returns

Client

get_function()

Get the function of the request.

Returns

str

get_scope()

Get the scope of request.

Returns

str

get_store_code()

Get the store code set for the request.

Returns

str

send() → merchantapi.abstract.Response

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_client(client: merchantapi.abstract.Client) → merchantapi.abstract.Request

Set the Client used for the request.

Parameters

client – Client

Returns

Request

set_store_code(store_code)

Set the store code for the request.

Parameters

store_code – str

Returns

Request

to_dict() → dict

Reduce the request to a dict

Returns

dict

class merchantapi.abstract.Response(request, data: dict)

Bases: object

get_data()

Get the underlying data object.

Returns

dict

get_error_code()

Get the error code.

Returns

str|None

get_error_field()

Get the field which triggered the error.

Returns

str|None

get_error_field_message()

Get the error message associated with the error field that cause the error. :returns: str|None

get_error_fields()

Get the fields which encountered a validation error.

Returns

list

get_error_input_count()

Get the number of input errors.

Returns

int

get_error_message()

Get the error message.

Returns

str|None

get_errors()

Get the error messages associated with the response.

Returns

list

get_request()

Get the initiating Request object.

Returns

Request

is_error()

Check if the response was a error.

Returns

bool

is_input_error()

Check if the error response is a input error.

Returns

bool

is_list_error()

Check if the error response is a list error.

Returns

bool

is_success()

Check if the response was a success.

Returns

bool

is_validation_error()

Check if the error response is a validation error.

Returns

bool

merchantapi.client module

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with self source code.

$Id: client.py 77669 2019-08-29 19:21:04Z gidriss $

class merchantapi.client.Client(endpoint: str, api_token: str, signing_key: str, options: dict = None)

Bases: object

DEFAULT_OPTIONS = {'default_store_code': None, 'require_timestamps': True, 'signing_key_digest': 'sha256', 'ssl_verify': True}

SIGN_DIGEST_NONE = None

SIGN_DIGEST_SHA1 = 'sha1'

SIGN_DIGEST_SHA256 = 'sha256'

generate_auth_header(data: str) → str

Generates the authentication header value.

Parameters

data – str

Returns

str

get_api_token() → str

Get the api token used to authenticate the request.

Returns

str

get_endpoint() → str

Get the API endpoint URL.

Returns

str

get_option(name: str, default=None)

Get a client option.

Parameters

• name – str

• default – default return value if not set

Returns

mixed

get_signing_key() → str

Get the signing key used to sign requests. Base64 encoded.

Returns

str

send(request: merchantapi.abstract.Request) → merchantapi.abstract.Response

Send a Request object with callback.

Parameters

request – Request

Raises

Exception –

Returns

Response

set_api_token(api_token: str) → merchantapi.client.Client

Set the api token used to authenticate the request.

Parameters

api_token – str

Returns

Client

set_endpoint(endpoint: str) → merchantapi.client.Client

Set the API endpoint URL.

Parameters

endpoint – str

Returns

Client

set_option(name: str, value) → merchantapi.client.Client

Set a client option.

Parameters

• name – str

• value – mixed

Returns

Client

set_signing_key(signing_key: str) → merchantapi.client.Client

Set the signing key used to sign requests. Base64 encoded.

Parameters

signing_key – str

Returns

Client

exception merchantapi.client.ClientException(request: merchantapi.abstract.Request = None, http_response: requests.models.Response = None, other: Exception = None)

Bases: Exception

get_http_response() → requests.models.Response

Get the Response object of the resulting http request, if available :return: requests.Response|None

get_other() → Exception

Get the passed Exception, if available :return: Exception|None

get_request() → merchantapi.abstract.Request

Get the Request object being sent :return: Request

merchantapi.listquery module

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with self source code.

$Id: listquery.py 77682 2019-08-29 23:21:44Z gidriss $

class merchantapi.listquery.FilterExpression(request: Optional[merchantapi.listquery.ListQueryRequest] = None)

Bases: object

FILTER_SEARCH = 'search'

FILTER_SEARCH_AND = 'search_AND'

FILTER_SEARCH_OR = 'search_OR'

OPERATOR_CO = 'CO'

OPERATOR_EQ = 'EQ'

OPERATOR_FALSE = 'FALSE'

OPERATOR_GE = 'GE'

OPERATOR_GT = 'GT'

OPERATOR_IN = 'IN'

OPERATOR_LE = 'LE'

OPERATOR_LIKE = 'LIKE'

OPERATOR_LT = 'LT'

OPERATOR_NC = 'NC'

OPERATOR_NE = 'NE'

OPERATOR_NOTLIKE = 'NOTLIKE'

OPERATOR_NOT_IN = 'NOT_IN'

OPERATOR_NULL = 'NULL'

OPERATOR_SUBWHERE = 'SUBWHERE'

OPERATOR_TRUE = 'TRUE'

VALID_FILTERS = ['search', 'search_AND', 'search_OR']

VALID_OPERATORS = ['EQ', 'GT', 'GE', 'LT', 'LE', 'CO', 'NC', 'LIKE', 'NOTLIKE', 'NE', 'TRUE', 'FALSE', 'NULL', 'IN', 'NOT_IN', 'SUBWHERE']

add(field: str, operator, value, filter_type) → merchantapi.listquery.FilterExpression

Add a search filter.

Parameters

• field – str

• operator – str

• value – mixed

• filter_type – str

Returns

FilterExpression

Raises

Exception –

and_contains(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a contains (AND x CO y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

and_does_not_contain(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a does not contains (AND x NC y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

and_equal(field: str, value: (<class 'str'>, <class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a equal (AND x EQ y) filter for specified field.

Parameters

• field – str

• value – mixed

Returns

FilterExpression

and_greater_than(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a greater than (AND x GT y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

and_greater_than_equal(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a greater than or equal (AND x GE y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

and_is_false(field: str) → merchantapi.listquery.FilterExpression

Add a false (AND x == false) filter for specified field.

Parameters

field – str

Returns

FilterExpression

and_is_in(field: str, values: (<class 'str'>, <class 'list'>)) → merchantapi.listquery.FilterExpression

Add a in (AND x IN y,z,.. ) filter for specified field.

Parameters

• field – str

• values – list|str

Returns

FilterExpression

and_is_null(field: str) → merchantapi.listquery.FilterExpression

Add a is None (AND x == None) filter for specified field.

Parameters

field – str

Returns

FilterExpression

and_is_true(field: str) → merchantapi.listquery.FilterExpression

Add a true (AND x == true) filter for specified field.

Parameters

field – str

Returns

FilterExpression

and_less_than(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a less than (AND x LT y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

and_less_than_equal(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a less than or equal (AND x LE y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

and_like(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a like (AND x LIKE y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

and_not_equal(field: str, value: (<class 'str'>, <class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a not equal (AND x NE y) filter for specified field.

Parameters

• field – str

• value – mixed

Returns

FilterExpression

and_not_in(field: str, values: (<class 'str'>, <class 'list'>)) → merchantapi.listquery.FilterExpression

Add a not in (AND x NOTIN y,z,.. ) filter for specified field.

Parameters

• field – str

• values – list|str

Returns

FilterExpression

and_not_like(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a not like (AND x NOTLIKE y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

and_x(expression) → merchantapi.listquery.FilterExpression

Add a AND expression.

Parameters

expression – FilterExpression

Returns

FilterExpression

Raises

Exception –

child_depth() → int

Get the child depth.

Returns

int

contains(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a contains (x CO y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

does_not_contain(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a does not contains (x NC y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

equal(field: str, value: (<class 'str'>, <class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a equal (x EQ y) filter for specified field.

Parameters

• field – str

• value – mixed

Returns

FilterExpression

expr() → merchantapi.listquery.FilterExpression

Create a new expression instance.

Returns

FilterExpression

get_parent() -> ('FilterExpression', None)

Get the parent expression.

Returns

FilterExpression|None

greater_than(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a greater than (x GT y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

greater_than_equal(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a greater than or equal (x GE y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

is_child() → bool

Check if self expression is a child of another.

Returns

bool

is_false(field: str) → merchantapi.listquery.FilterExpression

Add a false (x == false) filter for specified field.

Parameters

field – str

Returns

FilterExpression

is_in(field: str, values: (<class 'str'>, <class 'list'>)) → merchantapi.listquery.FilterExpression

Add a in (x IN y,z,.. ) filter for specified field.

Parameters

• field – str

• values – list|str

Returns

FilterExpression

is_null(field: str) → merchantapi.listquery.FilterExpression

Add a is None (x == None) filter for specified field.

Parameters

field – str

Returns

FilterExpression

is_true(field: str) → merchantapi.listquery.FilterExpression

Add a true (x == true) filter for specified field.

Parameters

field – str

Returns

FilterExpression

less_than(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a less than (x LT y) filter for specified field. :param field: str :param value: int|float :return: FilterExpression

less_than_equal(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a less than or equal (x LE y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

like(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a like (x LIKE y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

not_equal(field: str, value: (<class 'str'>, <class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a not equal (x NE y) filter for specified field.

Parameters

• field – str

• value – mixed

Returns

FilterExpression

not_in(field: str, values: (<class 'str'>, <class 'list'>)) → merchantapi.listquery.FilterExpression

Add a not in (x NOTIN y,z,.. ) filter for specified field.

Parameters

• field – str

• values – list|str

Returns

FilterExpression

not_like(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a not like (x NOTLIKE y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

or_contains(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a contains (OR x CO y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

or_does_not_contain(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a does not contains (OR x NC y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

or_equal(field: str, value: (<class 'str'>, <class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a equal (OR x EQ y) filter for specified field.

Parameters

• field – str

• value – mixed

Returns

FilterExpression

or_greater_than(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a greater than (OR x GT y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

or_greater_than_equal(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a greater than or equal (OR x GE y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

or_is_false(field: str) → merchantapi.listquery.FilterExpression

Add a false (OR x == false) filter for specified field.

Parameters

field – str

Returns

FilterExpression

or_is_in(field: str, values: (<class 'str'>, <class 'list'>)) → merchantapi.listquery.FilterExpression

Add a in (OR x IN y,z,.. ) filter for specified field.

Parameters

• field – str

• values – list|str

Returns

FilterExpression

or_is_null(field: str) → merchantapi.listquery.FilterExpression

Add a is None (OR x == None) filter for specified field.

Parameters

field – str

Returns

FilterExpression

or_is_true(field: str) → merchantapi.listquery.FilterExpression

Add a true (OR x == true) filter for specified field.

Parameters

field – str

Returns

FilterExpression

or_less_than(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a less than (OR x LT y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

or_less_than_equal(field: str, value: (<class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a less than or equal (OR x LE y) filter for specified field.

Parameters

• field – str

• value – int|float

Returns

FilterExpression

or_like(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a like (OR x LIKE y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

or_not_equal(field: str, value: (<class 'str'>, <class 'int'>, <class 'float'>)) → merchantapi.listquery.FilterExpression

Add a not equal (OR x NE y) filter for specified field.

Parameters

• field – str

• value – mixed

Returns

FilterExpression

or_not_in(field: str, values: (<class 'str'>, <class 'list'>)) → merchantapi.listquery.FilterExpression

Add a not in (OR x NOTIN y,z,.. ) filter for specified field.

Parameters

• field – str

• values – list|str

Returns

FilterExpression

or_not_like(field: str, value: str) → merchantapi.listquery.FilterExpression

Add a not like (OR x NOTLIKE y) filter for specified field.

Parameters

• field – str

• value – str

Returns

FilterExpression

or_x(expression) → merchantapi.listquery.FilterExpression

Add a OR expression.

Parameters

expression – FilterExpression

Returns

FilterExpression

Raises

Exception –

set_parent(parent=None) → merchantapi.listquery.FilterExpression

Set the parent expression.

Parameters

parent – FilterExpression|None

Returns

FilterExpression

to_list() → list

Reduce the built expression(s) to an array.

Returns

list

class merchantapi.listquery.FilterExpressionEntry(left, operator, right, search='search')

Bases: object

get_left() → str

Get the left side of the expression.

Returns

str

get_operator() → str

Get the expression operator.

Returns

str

get_right() → str

Get the right side of the expression.

Returns

str

set_left(left) → merchantapi.listquery.FilterExpressionEntry

Set the left side of the comparison.

Parameters

left – str

Returns

FilterExpressionEntry

set_operator(operator) → merchantapi.listquery.FilterExpressionEntry

Set the expression operator.

Parameters

operator – str

Returns

FilterExpressionEntry

set_right(right) → merchantapi.listquery.FilterExpressionEntry

Set the right side of the expression.

Parameters

right – str

Returns

FilterExpressionEntry

class merchantapi.listquery.ListQueryRequest(client: merchantapi.abstract.Client = None)

Bases: merchantapi.abstract.Request

SORT_ASCENDING = 'asc'

SORT_DESCENDING = 'desc'

add_on_demand_column(column: str) → merchantapi.listquery.ListQueryRequest

Add an on demand column to the request.

Parameters

column – str

Returns

ListQueryRequest

Raises

Exception –

available_custom_filters = {}

available_on_demand_columns = []

available_search_fields = []

available_sort_fields = []

create_response(data) → merchantapi.listquery.ListQueryResponse

Creates a ListQueryResponse from an api response

Returns

ListQueryResponse

filter_expression()

Creates a new FilterExpression object in the context of the request. :returns: FilterExpression

get_available_custom_filters() → dict

Get the available custom filters for the request.

Returns

dict

get_available_on_demand_columns() → list

Get the available on demand columns for the request.

Returns

list

get_available_search_fields() → list

Get the available search fields for the request.

Returns

list

get_available_sort_fields() → list

Get the available sorting fields for the request.

@returns: list

get_count() → int

Get the maximum records to request.

Returns

int

get_custom_filters() → list

Get the custom filters to apply.

Returns

list

get_filters() -> (<class 'list'>, 'FilterExpression')

Get the search filters to apply to the request.

Returns

list|FilterExpression

get_offset() → int

Get the record offset.

Returns

int

get_on_demand_columns() → list

Get the on demand columns to fetch.

Returns

list

get_sort() → str

Get the sorting field.

Returns

str

remove_custom_filter(name) → merchantapi.listquery.ListQueryRequest

Remove a custom filter applied to the request.

Parameters

name – str

Returns

ListQueryRequest

remove_on_demand_column(column: str) → merchantapi.listquery.ListQueryRequest

Remove an on demand column from the request.

Parameters

column – str

Returns

ListQueryRequest

set_count(count: int) → merchantapi.listquery.ListQueryRequest

Set the maximum records to request.

Parameters

count – int

Returns

ListQueryRequest

set_custom_filter(name: str, value) → merchantapi.listquery.ListQueryRequest

Set a custom filter supported by the request.

Parameters

• name – str

• value – mixed

Returns

ListQueryRequest

Raises

Exception –

set_filters(filters: (<class 'list'>, 'FilterExpression')) → merchantapi.listquery.ListQueryRequest

Set the search filters to apply to the request.

Parameters

filters – list|FilterExpression

Raises

Exception –

Returns

ListQueryRequest

set_offset(offset: int) → merchantapi.listquery.ListQueryRequest

Set the record offset.

Parameters

offset – int

Returns

ListQueryRequest

set_on_demand_columns(columns: list) → merchantapi.listquery.ListQueryRequest

Set the on demand columns to fetch.

Param

list

Returns

ListQueryRequest

set_sort(field: str, direction: str = 'asc') → merchantapi.listquery.ListQueryRequest

Set the sorting field.

Parameters

• field – str

• direction – str

Returns

ListQueryRequest

to_dict() → dict

Reduce the request to a dict

Returns

dict

class merchantapi.listquery.ListQueryResponse(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.abstract.Response

get_start_offset() → int

Get the starting offset of the result set

Returns

get_total_count() → int

Get the total count of returned records

Returns

int

merchantapi.model module

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

$Id: model.py 77709 2019-08-30 16:41:54Z gidriss $

class merchantapi.model.AvailabilityGroup(data: dict = None)

Bases: merchantapi.abstract.Model

get_id() → int

Get id.

Returns

int

get_name() → str

Get name.

Returns

string

class merchantapi.model.Category(data: dict = None)

Bases: merchantapi.abstract.Model

get_active() → bool

Get active.

Returns

bool

get_availability_group_count() → int

Get agrpcount.

Returns

int

get_code() → str

Get code.

Returns

string

get_custom_field_values()

Get CustomField_Values.

Returns

CustomFieldValues|None

get_date_time_created() → int

Get dt_created.

Returns

int

get_date_time_updated() → int

Get dt_updated.

Returns

int

get_depth() → int

Get depth.

Returns

int

get_display_order() → int

Get disp_order.

Returns

int

get_id() → int

Get id.

Returns

int

get_name() → str

Get name.

Returns

string

get_page_code() → str

Get page_code.

Returns

string

get_page_id() → int

Get page_id.

Returns

int

get_page_title() → str

Get page_title.

Returns

string

get_parent_category() → str

Get parent_category.

Returns

string

get_parent_id() → int

Get parent_id.

Returns

int

set_active(active: bool) → merchantapi.model.Category

Set active.

Parameters

active – bool

Returns

Category

set_code(code: str) → merchantapi.model.Category

Set code.

Parameters

code – string

Returns

Category

set_custom_field_values(custom_field_values) → merchantapi.model.Category

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues|dict

Returns

Category

Raises

Exception –

set_name(name: str) → merchantapi.model.Category

Set name.

Parameters

name – string

Returns

Category

set_page_code(page_code: str) → merchantapi.model.Category

Set page_code.

Parameters

page_code – string

Returns

Category

set_page_title(page_title: str) → merchantapi.model.Category

Set page_title.

Parameters

page_title – string

Returns

Category

set_parent_category(parent_category: str) → merchantapi.model.Category

Set parent_category.

Parameters

parent_category – string

Returns

Category

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.CategoryProduct(data: dict = None)

Bases: merchantapi.model.Product

get_assigned() → bool

Get assigned.

Returns

bool

class merchantapi.model.Coupon(data: dict = None)

Bases: merchantapi.abstract.Model

CUSTOMER_SCOPE_ALL_LOGGED_IN = 'L'

CUSTOMER_SCOPE_ALL_SHOPPERS = 'A'

CUSTOMER_SCOPE_SPECIFIC_CUSTOMERS = 'X'

get_active() → bool

Get active.

Returns

bool

get_code() → str

Get code.

Returns

string

get_customer_scope() → str

Get custscope.

Returns

string

get_date_time_end() → int

Get dt_end.

Returns

int

get_date_time_start() → int

Get dt_start.

Returns

int

get_description() → str

Get descrip.

Returns

string

get_id() → int

Get id.

Returns

int

get_max_per() → int

Get max_per.

Returns

int

get_max_use() → int

Get max_use.

Returns

int

get_use_count() → int

Get use_count.

Returns

int

set_active(active: bool) → merchantapi.model.Coupon

Set active.

Parameters

active – bool

Returns

Coupon

set_code(code: str) → merchantapi.model.Coupon

Set code.

Parameters

code – string

Returns

Coupon

set_customer_scope(customer_scope: str) → merchantapi.model.Coupon

Set custscope.

Parameters

customer_scope – string

Returns

Coupon

set_date_time_end(date_time_end)

Set dt_end.

Parameters

date_time_end – int

Returns

Coupon

set_date_time_start(date_time_start)

Set dt_start.

Parameters

date_time_start – int

Returns

Coupon

set_description(description: str) → merchantapi.model.Coupon

Set descrip.

Parameters

description – string

Returns

Coupon

set_max_per(max_per: int) → merchantapi.model.Coupon

Set max_per.

Parameters

max_per – int

Returns

Coupon

set_max_use(max_use: int) → merchantapi.model.Coupon

Set max_use.

Parameters

max_use – int

Returns

Coupon

class merchantapi.model.CouponPriceGroup(data: dict = None)

Bases: merchantapi.model.PriceGroup

get_assigned() → bool

Get assigned.

Returns

bool

class merchantapi.model.CustomFieldValues(data: dict = None)

Bases: merchantapi.abstract.Model

add_value(field: str, value, module: str = 'customfields') → merchantapi.model.CustomFieldValues

Same as set_value.

Parameters

• field – str

• value – mixed

• module – std

Returns

CustomFieldValues

get_module(module: str)

Get a specific modules custom field values.

Parameters

module – str

Returns

dict

get_value(code: str, module: str = 'customfields')

Get a value for a module by its code.

Parameters

• code – str

• module – str

Returns

mixed

has_module(module: str)

Check if a specific module is defined.

Parameters

module – str

Returns

boolean

has_value(code: str, module: str = 'customfields')

Check if a value for code and module exists.

Parameters

• code – {string}

• module – {string}

Returns

bool

set_value(field: str, value, module: str = 'customfields') → merchantapi.model.CustomFieldValues

Add a custom field value.

Parameters

• field – str

• value – mixed

• module – std

Returns

CustomFieldValues

class merchantapi.model.Customer(data: dict = None)

Bases: merchantapi.abstract.Model

get_account_id() → int

Get account_id.

Returns

int

get_bill_address1() → str

Get bill_addr1.

Returns

string

get_bill_address2() → str

Get bill_addr2.

Returns

string

get_bill_city() → str

Get bill_city.

Returns

string

get_bill_company() → str

Get bill_comp.

Returns

string

get_bill_country() → str

Get bill_cntry.

Returns

string

get_bill_email() → str

Get bill_email.

Returns

string

get_bill_fax() → str

Get bill_fax.

Returns

string

get_bill_first_name() → str

Get bill_fname.

Returns

string

get_bill_id() → int

Get bill_id.

Returns

int

get_bill_last_name() → str

Get bill_lname.

Returns

string

get_bill_phone() → str

Get bill_phone.

Returns

string

get_bill_state() → str

Get bill_state.

Returns

string

get_bill_zip() → str

Get bill_zip.

Returns

string

get_business_title() → str

Get business_title.

Returns

string

get_created_on() → int

Get dt_created.

Returns

int

get_credit() → float

Get credit.

Returns

float

get_custom_field_values()

Get CustomField_Values.

Returns

CustomFieldValues|None

get_formatted_credit() → str

Get formatted_credit.

Returns

string

get_id() → int

Get id.

Returns

int

get_last_login() → int

Get dt_login.

Returns

int

get_login() → str

Get login.

Returns

string

get_note_count() → int

Get note_count.

Returns

int

get_password_email() → str

Get pw_email.

Returns

string

get_ship_address1() → str

Get ship_addr1.

Returns

string

get_ship_address2() → str

Get ship_addr2.

Returns

string

get_ship_city() → str

Get ship_city.

Returns

string

get_ship_company() → str

Get ship_comp.

Returns

string

get_ship_country() → str

Get ship_cntry.

Returns

string

get_ship_email() → str

Get ship_email.

Returns

string

get_ship_fax() → str

Get ship_fax.

Returns

string

get_ship_first_name() → str

Get ship_fname.

Returns

string

get_ship_id() → int

Get ship_id.

Returns

int

get_ship_last_name() → str

Get ship_lname.

Returns

string

get_ship_phone() → str

Get ship_phone.

Returns

string

get_ship_state() → str

Get ship_state.

Returns

string

get_ship_zip() → str

Get ship_zip.

Returns

string

get_shipping_residential() → bool

Get ship_res.

Returns

bool

set_bill_address1(bill_address1: str) → merchantapi.model.Customer

Set bill_addr1.

Parameters

bill_address1 – string

Returns

Customer

set_bill_address2(bill_address2: str) → merchantapi.model.Customer

Set bill_addr2.

Parameters

bill_address2 – string

Returns

Customer

set_bill_city(bill_city: str) → merchantapi.model.Customer

Set bill_city.

Parameters

bill_city – string

Returns

Customer

set_bill_company(bill_company: str) → merchantapi.model.Customer

Set bill_comp.

Parameters

bill_company – string

Returns

Customer

set_bill_country(bill_country: str) → merchantapi.model.Customer

Set bill_cntry.

Parameters

bill_country – string

Returns

Customer

set_bill_email(bill_email: str) → merchantapi.model.Customer

Set bill_email.

Parameters

bill_email – string

Returns

Customer

set_bill_fax(bill_fax: str) → merchantapi.model.Customer

Set bill_fax.

Parameters

bill_fax – string

Returns

Customer

set_bill_first_name(bill_first_name: str) → merchantapi.model.Customer

Set bill_fname.

Parameters

bill_first_name – string

Returns

Customer

set_bill_last_name(bill_last_name: str) → merchantapi.model.Customer

Set bill_lname.

Parameters

bill_last_name – string

Returns

Customer

set_bill_phone(bill_phone: str) → merchantapi.model.Customer

Set bill_phone.

Parameters

bill_phone – string

Returns

Customer

set_bill_state(bill_state: str) → merchantapi.model.Customer

Set bill_state.

Parameters

bill_state – string

Returns

Customer

set_bill_zip(bill_zip: str) → merchantapi.model.Customer

Set bill_zip.

Parameters

bill_zip – string

Returns

Customer

set_custom_field_values(custom_field_values) → merchantapi.model.Customer

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues|dict

Returns

Customer

Raises

Exception –

set_login(login: str) → merchantapi.model.Customer

Set login.

Parameters

login – string

Returns

Customer

set_password_email(password_email: str) → merchantapi.model.Customer

Set pw_email.

Parameters

password_email – string

Returns

Customer

set_ship_address1(ship_address1: str) → merchantapi.model.Customer

Set ship_addr1.

Parameters

ship_address1 – string

Returns

Customer

set_ship_address2(ship_address2: str) → merchantapi.model.Customer

Set ship_addr2.

Parameters

ship_address2 – string

Returns

Customer

set_ship_city(ship_city: str) → merchantapi.model.Customer

Set ship_city.

Parameters

ship_city – string

Returns

Customer

set_ship_company(ship_company: str) → merchantapi.model.Customer

Set ship_comp.

Parameters

ship_company – string

Returns

Customer

set_ship_country(ship_country: str) → merchantapi.model.Customer

Set ship_cntry.

Parameters

ship_country – string

Returns

Customer

set_ship_email(ship_email: str) → merchantapi.model.Customer

Set ship_email.

Parameters

ship_email – string

Returns

Customer

set_ship_fax(ship_fax: str) → merchantapi.model.Customer

Set ship_fax.

Parameters

ship_fax – string

Returns

Customer

set_ship_first_name(ship_first_name: str) → merchantapi.model.Customer

Set ship_fname.

Parameters

ship_first_name – string

Returns

Customer

set_ship_last_name(ship_last_name: str) → merchantapi.model.Customer

Set ship_lname.

Parameters

ship_last_name – string

Returns

Customer

set_ship_phone(ship_phone: str) → merchantapi.model.Customer

Set ship_phone.

Parameters

ship_phone – string

Returns

Customer

set_ship_state(ship_state: str) → merchantapi.model.Customer

Set ship_state.

Parameters

ship_state – string

Returns

Customer

set_ship_zip(ship_zip: str) → merchantapi.model.Customer

Set ship_zip.

Parameters

ship_zip – string

Returns

Customer

set_shipping_residential(shipping_residential: bool) → merchantapi.model.Customer

Set ship_res.

Parameters

shipping_residential – bool

Returns

Customer

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.CustomerAddress(data: dict = None)

Bases: merchantapi.abstract.Model

get_address1() → str

Get addr1.

Returns

string

get_address2() → str

Get addr2.

Returns

string

get_city() → str

Get city.

Returns

string

get_company() → str

Get comp.

Returns

string

get_country() → str

Get cntry.

Returns

string

get_customer_id() → int

Get cust_id.

Returns

int

get_description() → str

Get descrip.

Returns

string

get_email() → str

Get email.

Returns

string

get_fax() → str

Get fax.

Returns

string

get_first_name() → str

Get fname.

Returns

string

get_id() → int

Get id.

Returns

int

get_last_name() → str

Get lname.

Returns

string

get_phone() → str

Get phone.

Returns

string

get_residential() → bool

Get resdntl.

Returns

bool

get_state() → str

Get state.

Returns

string

get_zip() → str

Get zip.

Returns

string

class merchantapi.model.CustomerPaymentCard(data: dict = None)

Bases: merchantapi.abstract.Model

get_address1() → str

Get addr1.

Returns

string

get_address2() → str

Get addr2.

Returns

string

get_city() → str

Get city.

Returns

string

get_country() → str

Get cntry.

Returns

string

get_customer_id() → int

Get cust_id.

Returns

int

get_expiration_month() → int

Get exp_month.

Returns

int

get_expiration_year() → int

Get exp_year.

Returns

int

get_first_name() → str

Get fname.

Returns

string

get_id() → int

Get id.

Returns

int

get_last_four() → str

Get lastfour.

Returns

string

get_last_name() → str

Get lname.

Returns

string

get_last_used() → str

Get lastused.

Returns

string

get_method_code() → str

Get meth_code.

Returns

string

get_module_code() → str

Get mod_code.

Returns

string

get_reference_count() → int

Get refcount.

Returns

int

get_state() → str

Get state.

Returns

string

get_token() → str

Get token.

Returns

string

get_type() → str

Get type.

Returns

string

get_type_id() → int

Get type_id.

Returns

int

get_zip() → str

Get zip.

Returns

string

class merchantapi.model.CustomerPriceGroup(data: dict = None)

Bases: merchantapi.model.PriceGroup

get_assigned() → bool

Get assigned.

Returns

bool

class merchantapi.model.DiscountModuleCapabilities(data: dict = None)

Bases: merchantapi.abstract.Model

get_basket() → bool

Get basket.

Returns

bool

get_eligibility() → str

Get eligibility.

Returns

string

get_items() → bool

Get items.

Returns

bool

get_preitems() → bool

Get preitems.

Returns

bool

get_qualifying() → bool

Get qualifying.

Returns

bool

get_shipping() → bool

Get shipping.

Returns

bool

class merchantapi.model.Module(data: dict = None)

Bases: merchantapi.abstract.Model

get_active() → bool

Get active.

Returns

bool

get_api_version() → str

Get api_ver.

Returns

string

get_code() → str

Get code.

Returns

string

get_id() → int

Get id.

Returns

int

get_module() → str

Get module.

Returns

string

get_name() → str

Get name.

Returns

string

get_provider() → str

Get provider.

Returns

string

get_reference_count() → int

Get refcount.

Returns

int

get_version() → str

Get version.

Returns

string

class merchantapi.model.Note(data: dict = None)

Bases: merchantapi.abstract.Model

get_account_id() → int

Get account_id.

Returns

int

get_admin_user() → str

Get admin_user.

Returns

string

get_business_title() → str

Get business_title.

Returns

string

get_customer_id() → int

Get cust_id.

Returns

int

get_customer_login() → str

Get cust_login.

Returns

string

get_date_time_stamp() → int

Get dtstamp.

Returns

int

get_id() → int

Get id.

Returns

int

get_note_text() → str

Get notetext.

Returns

string

get_order_id() → int

Get order_id.

Returns

int

get_user_id() → int

Get user_id.

Returns

int

set_account_id(account_id: int) → merchantapi.model.Note

Set account_id.

Parameters

account_id – int

Returns

Note

set_customer_id(customer_id: int) → merchantapi.model.Note

Set cust_id.

Parameters

customer_id – int

Returns

Note

set_note_text(note_text: str) → merchantapi.model.Note

Set notetext.

Parameters

note_text – string

Returns

Note

set_order_id(order_id: int) → merchantapi.model.Note

Set order_id.

Parameters

order_id – int

Returns

Note

class merchantapi.model.Order(data: dict = None)

Bases: merchantapi.abstract.Model

ORDER_PAYMENT_STATUS_AUTHORIZED = 100

ORDER_PAYMENT_STATUS_CAPTURED = 200

ORDER_PAYMENT_STATUS_PARTIALLY_CAPTURED = 201

ORDER_PAYMENT_STATUS_PENDING = 0

ORDER_STATUS_BACKORDERED = 400

ORDER_STATUS_CANCELLED = 300

ORDER_STATUS_PARTIALLY_SHIPPED = 201

ORDER_STATUS_PENDING = 0

ORDER_STATUS_PROCESSING = 100

ORDER_STATUS_RETURNED = 600

ORDER_STATUS_RMA_ISSUED = 500

ORDER_STATUS_SHIPPED = 200

ORDER_STOCK_STATUS_AVAILABLE = 100

ORDER_STOCK_STATUS_PARTIAL = 201

ORDER_STOCK_STATUS_UNAVAILABLE = 200

get_backorder_count() → int

Get bord_count.

Returns

int

get_batch_id() → int

Get batch_id.

Returns

int

get_bill_address1() → str

Get bill_addr1.

Returns

string

get_bill_address2() → str

Get bill_addr2.

Returns

string

get_bill_city() → str

Get bill_city.

Returns

string

get_bill_company() → str

Get bill_comp.

Returns

string

get_bill_country() → str

Get bill_cntry.

Returns

string

get_bill_email() → str

Get bill_email.

Returns

string

get_bill_fax() → str

Get bill_fax.

Returns

string

get_bill_first_name() → str

Get bill_fname.

Returns

string

get_bill_last_name() → str

Get bill_lname.

Returns

string

get_bill_phone() → str

Get bill_phone.

Returns

string

get_bill_state() → str

Get bill_state.

Returns

string

get_bill_zip() → str

Get bill_zip.

Returns

string

get_business_title() → str

Get business_title.

Returns

string

get_charges()

Get charges.

Returns

List of OrderCharge

get_coupons()

Get coupons.

Returns

List of OrderCoupon

get_custom_field_values()

Get CustomField_Values.

Returns

CustomFieldValues|None

get_customer()

Get customer.

Returns

Customer|None

get_customer_id() → int

Get cust_id.

Returns

int

get_customer_login() → str

Get cust_login.

Returns

string

get_customer_password_email() → str

Get cust_pw_email.

Returns

string

get_date_in_stock() → int

Get dt_instock.

Returns

int

get_discounts()

Get discounts.

Returns

List of OrderDiscountTotal

get_formatted_net_captured() → str

Get formatted_net_capt.

Returns

string

get_formatted_total() → str

Get formatted_total.

Returns

string

get_formatted_total_authorized() → str

Get formatted_total_auth.

Returns

string

get_formatted_total_captured() → str

Get formatted_total_capt.

Returns

string

get_formatted_total_refunded() → str

Get formatted_total_rfnd.

Returns

string

get_formatted_total_ship() → str

Get formatted_total_ship.

Returns

string

get_formatted_total_tax() → str

Get formatted_total_tax.

Returns

string

get_id() → int

Get id.

Returns

int

get_items()

Get items.

Returns

List of OrderItem

get_net_captured() → float

Get net_capt.

Returns

float

get_note_count() → int

Get note_count.

Returns

int

get_notes()

Get notes.

Returns

List of OrderNote

get_order_date() → int

Get orderdate.

Returns

int

get_payment_id() → int

Get pay_id.

Returns

int

get_payment_module() → str

Get payment_module.

Returns

string

get_payment_status() → int

Get pay_status.

Returns

int

get_payments()

Get payments.

Returns

List of OrderPayment

get_pending_count() → int

Get pend_count.

Returns

int

get_ship_address1() → str

Get ship_addr1.

Returns

string

get_ship_address2() → str

Get ship_addr2.

Returns

string

get_ship_city() → str

Get ship_city.

Returns

string

get_ship_company() → str

Get ship_comp.

Returns

string

get_ship_country() → str

Get ship_cntry.

Returns

string

get_ship_data() → str

Get ship_data.

Returns

string

get_ship_email() → str

Get ship_email.

Returns

string

get_ship_fax() → str

Get ship_fax.

Returns

string

get_ship_first_name() → str

Get ship_fname.

Returns

string

get_ship_last_name() → str

Get ship_lname.

Returns

string

get_ship_method() → str

Get ship_method.

Returns

string

get_ship_phone() → str

Get ship_phone.

Returns

string

get_ship_residential() → bool

Get ship_res.

Returns

bool

get_ship_state() → str

Get ship_state.

Returns

string

get_ship_zip() → str

Get ship_zip.

Returns

string

get_shipment_id() → int

Get ship_id.

Returns

int

get_source() → str

Get source.

Returns

string

get_source_id() → int

Get source_id.

Returns

int

get_status() → int

Get status.

Returns

int

get_stock_status() → int

Get stk_status.

Returns

int

get_total() → float

Get total.

Returns

float

get_total_authorized() → float

Get total_auth.

Returns

float

get_total_captured() → float

Get total_capt.

Returns

float

get_total_refunded() → float

Get total_rfnd.

Returns

float

get_total_ship() → float

Get total_ship.

Returns

float

get_total_tax() → float

Get total_tax.

Returns

float

set_bill_address1(bill_address1: str) → merchantapi.model.Order

Set bill_addr1.

Parameters

bill_address1 – string

Returns

Order

set_bill_address2(bill_address2: str) → merchantapi.model.Order

Set bill_addr2.

Parameters

bill_address2 – string

Returns

Order

set_bill_city(bill_city: str) → merchantapi.model.Order

Set bill_city.

Parameters

bill_city – string

Returns

Order

set_bill_company(bill_company: str) → merchantapi.model.Order

Set bill_comp.

Parameters

bill_company – string

Returns

Order

set_bill_country(bill_country: str) → merchantapi.model.Order

Set bill_cntry.

Parameters

bill_country – string

Returns

Order

set_bill_email(bill_email: str) → merchantapi.model.Order

Set bill_email.

Parameters

bill_email – string

Returns

Order

set_bill_fax(bill_fax: str) → merchantapi.model.Order

Set bill_fax.

Parameters

bill_fax – string

Returns

Order

set_bill_first_name(bill_first_name: str) → merchantapi.model.Order

Set bill_fname.

Parameters

bill_first_name – string

Returns

Order

set_bill_last_name(bill_last_name: str) → merchantapi.model.Order

Set bill_lname.

Parameters

bill_last_name – string

Returns

Order

set_bill_phone(bill_phone: str) → merchantapi.model.Order

Set bill_phone.

Parameters

bill_phone – string

Returns

Order

set_bill_state(bill_state: str) → merchantapi.model.Order

Set bill_state.

Parameters

bill_state – string

Returns

Order

set_bill_zip(bill_zip: str) → merchantapi.model.Order

Set bill_zip.

Parameters

bill_zip – string

Returns

Order

set_customer_id(customer_id: int) → merchantapi.model.Order

Set cust_id.

Parameters

customer_id – int

Returns

Order

set_ship_address1(ship_address1: str) → merchantapi.model.Order

Set ship_addr1.

Parameters

ship_address1 – string

Returns

Order

set_ship_address2(ship_address2: str) → merchantapi.model.Order

Set ship_addr2.

Parameters

ship_address2 – string

Returns

Order

set_ship_city(ship_city: str) → merchantapi.model.Order

Set ship_city.

Parameters

ship_city – string

Returns

Order

set_ship_company(ship_company: str) → merchantapi.model.Order

Set ship_comp.

Parameters

ship_company – string

Returns

Order

set_ship_country(ship_country: str) → merchantapi.model.Order

Set ship_cntry.

Parameters

ship_country – string

Returns

Order

set_ship_email(ship_email: str) → merchantapi.model.Order

Set ship_email.

Parameters

ship_email – string

Returns

Order

set_ship_fax(ship_fax: str) → merchantapi.model.Order

Set ship_fax.

Parameters

ship_fax – string

Returns

Order

set_ship_first_name(ship_first_name: str) → merchantapi.model.Order

Set ship_fname.

Parameters

ship_first_name – string

Returns

Order

set_ship_last_name(ship_last_name: str) → merchantapi.model.Order

Set ship_lname.

Parameters

ship_last_name – string

Returns

Order

set_ship_phone(ship_phone: str) → merchantapi.model.Order

Set ship_phone.

Parameters

ship_phone – string

Returns

Order

set_ship_state(ship_state: str) → merchantapi.model.Order

Set ship_state.

Parameters

ship_state – string

Returns

Order

set_ship_zip(ship_zip: str) → merchantapi.model.Order

Set ship_zip.

Parameters

ship_zip – string

Returns

Order

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.OrderCharge(data: dict = None)

Bases: merchantapi.abstract.Model

get_amount() → float

Get amount.

Returns

float

get_charge_id() → int

Get charge_id.

Returns

int

get_description() → str

Get descrip.

Returns

string

get_display_amount() → float

Get disp_amt.

Returns

float

get_module_id() → int

Get module_id.

Returns

int

get_order_id() → int

Get order_id.

Returns

int

get_tax_exempt() → bool

Get tax_exempt.

Returns

bool

get_type() → str

Get type.

Returns

string

set_amount(amount: float) → merchantapi.model.OrderCharge

Set amount.

Parameters

amount – int

Returns

OrderCharge

set_description(description: str) → merchantapi.model.OrderCharge

Set descrip.

Parameters

description – string

Returns

OrderCharge

set_display_amount(display_amount: float) → merchantapi.model.OrderCharge

Set disp_amt.

Parameters

display_amount – int

Returns

OrderCharge

set_tax_exempt(tax_exempt: bool) → merchantapi.model.OrderCharge

Set tax_exempt.

Parameters

tax_exempt – bool

Returns

OrderCharge

set_type(type: str) → merchantapi.model.OrderCharge

Set type.

Parameters

type – string

Returns

OrderCharge

class merchantapi.model.OrderCoupon(data: dict = None)

Bases: merchantapi.abstract.Model

get_code() → str

Get code.

Returns

string

get_coupon_id() → int

Get coupon_id.

Returns

int

get_description() → str

Get descrip.

Returns

string

get_order_id() → int

Get order_id.

Returns

int

get_total() → float

Get total.

Returns

float

class merchantapi.model.OrderCustomField(data: dict = None)

Bases: merchantapi.abstract.Model

get_choices() → dict

Get choices.

Returns

dict

get_code() → str

Get code.

Returns

string

get_module()

Get module.

Returns

Module|None

get_name() → str

Get name.

Returns

string

get_searchable() → bool

Get searchable.

Returns

bool

get_sortable() → bool

Get sortable.

Returns

bool

get_type() → str

Get type.

Returns

string

set_choices(choices) → merchantapi.model.OrderCustomField

Set choices.

Parameters

choices – list

Returns

OrderCustomField

set_code(code: str) → merchantapi.model.OrderCustomField

Set code.

Parameters

code – string

Returns

OrderCustomField

set_module(module) → merchantapi.model.OrderCustomField

Set module.

Parameters

module – Module|dict

Returns

OrderCustomField

Raises

Exception –

set_name(name: str) → merchantapi.model.OrderCustomField

Set name.

Parameters

name – string

Returns

OrderCustomField

set_searchable(searchable: bool) → merchantapi.model.OrderCustomField

Set searchable.

Parameters

searchable – bool

Returns

OrderCustomField

set_sortable(sortable: bool) → merchantapi.model.OrderCustomField

Set sortable.

Parameters

sortable – bool

Returns

OrderCustomField

set_type(type: str) → merchantapi.model.OrderCustomField

Set type.

Parameters

type – string

Returns

OrderCustomField

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.OrderDiscountTotal(data: dict = None)

Bases: merchantapi.abstract.Model

get_description() → str

Get descrip.

Returns

string

get_name() → str

Get name.

Returns

string

get_order_id() → int

Get order_id.

Returns

int

get_price_group_id() → int

Get pgrp_id.

Returns

int

get_total() → float

Get total.

Returns

float

class merchantapi.model.OrderItem(data: dict = None)

Bases: merchantapi.abstract.Model

ORDER_ITEM_STATUS_BACKORDERED = 400

ORDER_ITEM_STATUS_CANCELLED = 300

ORDER_ITEM_STATUS_DIGITAL_DOWNLOADED = 221

ORDER_ITEM_STATUS_DIGITAL_NOT_DOWNLOADED = 220

ORDER_ITEM_STATUS_GIFT_CERT_NOT_REDEEMED = 210

ORDER_ITEM_STATUS_GIFT_CERT_REDEEMED = 211

ORDER_ITEM_STATUS_PARTIALLY_SHIPPED = 201

ORDER_ITEM_STATUS_PENDING = 0

ORDER_ITEM_STATUS_PROCESSING = 100

ORDER_ITEM_STATUS_RETURNED = 600

ORDER_ITEM_STATUS_RMA_ISSUED = 500

ORDER_ITEM_STATUS_SHIPPED = 200

add_option(option: merchantapi.model.OrderItemOption) → merchantapi.model.OrderItem

Add a OrderItemOption.

Parameters

option – OrderItemOption

Returns

OrderItem

get_base_price() → float

Get base_price.

Returns

float

get_code() → str

Get code.

Returns

string

get_date_in_stock() → int

Get dt_instock.

Returns

int

get_discounts()

Get discounts.

Returns

List of OrderItemDiscount

get_line_id() → int

Get line_id.

Returns

int

get_name() → str

Get name.

Returns

string

get_options()

Get options.

Returns

List of OrderItemOption

get_order_id() → int

Get order_id.

Returns

int

get_price() → float

Get price.

Returns

float

get_quantity() → int

Get quantity.

Returns

int

get_retail() → float

Get retail.

Returns

float

get_rma_code() → str

Get rma_code.

Returns

string

get_rma_data_time_issued() → int

Get rma_dt_issued.

Returns

int

get_rma_date_time_received() → int

Get rma_dt_recvd.

Returns

int

get_rma_id() → int

Get rma_id.

Returns

int

get_shipment()

Get shipment.

Returns

OrderShipment|None

get_sku() → str

Get sku.

Returns

string

get_status() → int

Get status.

Returns

int

get_subscription()

Get subscription.

Returns

OrderItemSubscription|None

get_subscription_id() → int

Get subscrp_id.

Returns

int

get_subscription_term_id() → int

Get subterm_id.

Returns

int

get_taxable() → bool

Get taxable.

Returns

bool

get_total() → float

Get total.

Returns

float

get_tracking_number() → str

Get tracknum.

Returns

string

get_tracking_type() → str

Get tracktype.

Returns

string

get_upsold() → bool

Get upsold.

Returns

bool

get_weight() → float

Get weight.

Returns

float

set_code(code: str) → merchantapi.model.OrderItem

Set code.

Parameters

code – string

Returns

OrderItem

set_name(name: str) → merchantapi.model.OrderItem

Set name.

Parameters

name – string

Returns

OrderItem

set_options(options: list) → merchantapi.model.OrderItem

Set options.

Parameters

options – List of OrderItemOption

Raises

Exception –

Returns

OrderItem

set_price(price: float) → merchantapi.model.OrderItem

Set price.

Parameters

price – int

Returns

OrderItem

set_quantity(quantity: int) → merchantapi.model.OrderItem

Set quantity.

Parameters

quantity – int

Returns

OrderItem

set_sku(sku: str) → merchantapi.model.OrderItem

Set sku.

Parameters

sku – string

Returns

OrderItem

set_status(status: int) → merchantapi.model.OrderItem

Set status.

Parameters

status – int

Returns

OrderItem

set_taxable(taxable: bool) → merchantapi.model.OrderItem

Set taxable.

Parameters

taxable – bool

Returns

OrderItem

set_tracking_number(tracking_number: str) → merchantapi.model.OrderItem

Set tracknum.

Parameters

tracking_number – string

Returns

OrderItem

set_tracking_type(tracking_type: str) → merchantapi.model.OrderItem

Set tracktype.

Parameters

tracking_type – string

Returns

OrderItem

set_upsold(upsold: bool) → merchantapi.model.OrderItem

Set upsold.

Parameters

upsold – bool

Returns

OrderItem

set_weight(weight: float) → merchantapi.model.OrderItem

Set weight.

Parameters

weight – int

Returns

OrderItem

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.OrderItemAttribute(data: dict = None)

Bases: merchantapi.abstract.Model

get_attribute_code() → str

Get attr_code.

Returns

string

get_option_code_or_data() → str

Get opt_code_or_data.

Returns

string

get_price() → float

Get price.

Returns

float

get_weight() → float

Get weight.

Returns

float

set_attribute_code(attribute_code: str) → merchantapi.model.OrderItemAttribute

Set attr_code.

Parameters

attribute_code – string

Returns

OrderItemAttribute

set_option_code_or_data(option_code_or_data: str) → merchantapi.model.OrderItemAttribute

Set opt_code_or_data.

Parameters

option_code_or_data – string

Returns

OrderItemAttribute

set_price(price: float) → merchantapi.model.OrderItemAttribute

Set price.

Parameters

price – int

Returns

OrderItemAttribute

set_weight(weight: float) → merchantapi.model.OrderItemAttribute

Set weight.

Parameters

weight – int

Returns

OrderItemAttribute

class merchantapi.model.OrderItemDiscount(data: dict = None)

Bases: merchantapi.abstract.Model

get_description() → str

Get descrip.

Returns

string

get_discount() → float

Get discount.

Returns

float

get_display() → bool

Get display.

Returns

bool

get_line_id() → int

Get line_id.

Returns

int

get_order_id() → int

Get order_id.

Returns

int

get_price_group_id() → int

Get pgrp_id.

Returns

int

class merchantapi.model.OrderItemOption(data: dict = None)

Bases: merchantapi.abstract.Model

get_attribute() → str

Get attribute.

Returns

string

get_base_price() → float

Get base_price.

Returns

float

get_price() → float

Get price.

Returns

float

get_retail() → float

Get retail.

Returns

float

get_value() → str

Get value.

Returns

string

get_weight() → float

Get weight.

Returns

float

set_attribute(attribute: str) → merchantapi.model.OrderItemOption

Set attribute.

Parameters

attribute – string

Returns

OrderItemOption

set_price(price: float) → merchantapi.model.OrderItemOption

Set price.

Parameters

price – int

Returns

OrderItemOption

set_value(value: str) → merchantapi.model.OrderItemOption

Set value.

Parameters

value – string

Returns

OrderItemOption

set_weight(weight: float) → merchantapi.model.OrderItemOption

Set weight.

Parameters

weight – int

Returns

OrderItemOption

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.OrderItemSubscription(data: dict = None)

Bases: merchantapi.abstract.Model

get_method() → str

Get method.

Returns

string

get_options()

Get options.

Returns

List of SubscriptionOption

get_product_subscription_term()

Get productsubscriptionterm.

Returns

ProductSubscriptionTerm|None

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.OrderNote(data: dict = None)

Bases: merchantapi.model.Note

class merchantapi.model.OrderPayment(data: dict = None)

Bases: merchantapi.abstract.Model

ORDER_PAYMENT_TYPE_AUTH = 3

ORDER_PAYMENT_TYPE_AUTH_CAPTURE = 5

ORDER_PAYMENT_TYPE_CAPTURE = 4

ORDER_PAYMENT_TYPE_DECLINED = 0

ORDER_PAYMENT_TYPE_LEGACY_AUTH = 1

ORDER_PAYMENT_TYPE_LEGACY_CAPTURE = 2

ORDER_PAYMENT_TYPE_REFUND = 6

ORDER_PAYMENT_TYPE_VOID = 7

get_amount() → float

Get amount.

Returns

float

get_available() → float

Get available.

Returns

float

get_date_time_stamp() → int

Get dtstamp.

Returns

int

get_decrypt_error() → str

Get decrypt_error.

Returns

string

get_decrypt_status() → str

Get decrypt_status.

Returns

string

get_description() → str

Get description.

Returns

string

get_expires() → str

Get expires.

Returns

string

get_formatted_amount() → str

Get formatted_amount.

Returns

string

get_formatted_available() → str

Get formatted_available.

Returns

string

get_id() → int

Get id.

Returns

int

get_order_id() → int

Get order_id.

Returns

int

get_payment_data() → dict

Get data.

Returns

dict

get_payment_id() → int

Get pay_id.

Returns

int

get_payment_sec_id() → int

Get pay_secid.

Returns

int

get_reference_number() → str

Get refnum.

Returns

string

get_type() → int

Get type.

Returns

int

class merchantapi.model.OrderPaymentAuthorize(data: dict = None)

Bases: merchantapi.abstract.Model

get_formatted_net_captured() → str

Get formatted_net_capt.

Returns

string

get_formatted_total_authorized() → str

Get formatted_total_auth.

Returns

string

get_formatted_total_captured() → str

Get formatted_total_capt.

Returns

string

get_formatted_total_refunded() → str

Get formatted_total_rfnd.

Returns

string

get_net_captured() → float

Get net_capt.

Returns

float

get_total_authorized() → float

Get total_auth.

Returns

float

get_total_captured() → float

Get total_capt.

Returns

float

get_total_refunded() → float

Get total_rfnd.

Returns

float

get_valid() → bool

Get valid.

Returns

bool

class merchantapi.model.OrderPaymentCard(data: dict = None)

Bases: merchantapi.model.CustomerPaymentCard

class merchantapi.model.OrderPaymentTotal(data: dict = None)

Bases: merchantapi.abstract.Model

get_formatted_net_captured() → str

Get formatted_net_capt.

Returns

string

get_formatted_total_authorized() → str

Get formatted_total_auth.

Returns

string

get_formatted_total_captured() → str

Get formatted_total_capt.

Returns

string

get_formatted_total_refunded() → str

Get formatted_total_rfnd.

Returns

string

get_net_captured() → float

Get net_capt.

Returns

float

get_order_id() → int

Get order_id.

Returns

int

get_total_authorized() → float

Get total_auth.

Returns

float

get_total_captured() → float

Get total_capt.

Returns

float

get_total_refunded() → float

Get total_rfnd.

Returns

float

class merchantapi.model.OrderProduct(data: dict = None)

Bases: merchantapi.abstract.Model

add_attribute(attribute: merchantapi.model.OrderProductAttribute) → merchantapi.model.OrderProduct

Add a OrderProductAttribute.

Parameters

attribute – OrderProductAttribute

Returns

OrderProduct

get_attributes()

Get attributes.

Returns

List of OrderProductAttribute

get_code() → str

Get code.

Returns

string

get_quantity() → int

Get quantity.

Returns

int

get_sku() → str

Get sku.

Returns

string

get_status() → int

Get status.

Returns

int

get_tracking_number() → str

Get tracknum.

Returns

string

get_tracking_type() → str

Get tracktype.

Returns

string

set_attributes(attributes: list) → merchantapi.model.OrderProduct

Set attributes.

Parameters

attributes – List of OrderProductAttribute

Raises

Exception –

Returns

OrderProduct

set_code(code: str) → merchantapi.model.OrderProduct

Set code.

Parameters

code – string

Returns

OrderProduct

set_quantity(quantity: int) → merchantapi.model.OrderProduct

Set quantity.

Parameters

quantity – int

Returns

OrderProduct

set_sku(sku: str) → merchantapi.model.OrderProduct

Set sku.

Parameters

sku – string

Returns

OrderProduct

set_status(status: int) → merchantapi.model.OrderProduct

Set status.

Parameters

status – int

Returns

OrderProduct

set_tracking_number(tracking_number: str) → merchantapi.model.OrderProduct

Set tracknum.

Parameters

tracking_number – string

Returns

OrderProduct

set_tracking_type(tracking_type: str) → merchantapi.model.OrderProduct

Set tracktype.

Parameters

tracking_type – string

Returns

OrderProduct

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.OrderProductAttribute(data: dict = None)

Bases: merchantapi.abstract.Model

get_code() → str

Get code.

Returns

string

get_template_code() → str

Get template_code.

Returns

string

get_value() → str

Get value.

Returns

string

set_code(code: str) → merchantapi.model.OrderProductAttribute

Set code.

Parameters

code – string

Returns

OrderProductAttribute

set_template_code(template_code: str) → merchantapi.model.OrderProductAttribute

Set template_code.

Parameters

template_code – string

Returns

OrderProductAttribute

set_value(value: str) → merchantapi.model.OrderProductAttribute

Set value.

Parameters

value – string

Returns

OrderProductAttribute

class merchantapi.model.OrderShipment(data: dict = None)

Bases: merchantapi.abstract.Model

ORDER_SHIPMENT_STATUS_PENDING = 0

ORDER_SHIPMENT_STATUS_PICKING = 100

ORDER_SHIPMENT_STATUS_SHIPPED = 200

get_batch_id() → int

Get batch_id.

Returns

int

get_code() → str

Get code.

Returns

string

get_cost() → float

Get cost.

Returns

float

get_formatted_cost() → str

Get formatted_cost.

Returns

string

get_id() → int

Get id.

Returns

int

get_label_count() → int

Get labelcount.

Returns

int

get_order_id() → int

Get order_id.

Returns

int

get_ship_date() → int

Get ship_date.

Returns

int

get_status() → int

Get status.

Returns

int

get_tracking_link() → str

Get tracklink.

Returns

string

get_tracking_number() → str

Get tracknum.

Returns

string

get_tracking_type() → str

Get tracktype.

Returns

string

get_weight() → float

Get weight.

Returns

float

set_batch_id(batch_id: int) → merchantapi.model.OrderShipment

Set batch_id.

Parameters

batch_id – int

Returns

OrderShipment

set_code(code: str) → merchantapi.model.OrderShipment

Set code.

Parameters

code – string

Returns

OrderShipment

set_cost(cost: float) → merchantapi.model.OrderShipment

Set cost.

Parameters

cost – int

Returns

OrderShipment

set_id(id: int) → merchantapi.model.OrderShipment

Set id.

Parameters

id – int

Returns

OrderShipment

set_label_count(label_count: int) → merchantapi.model.OrderShipment

Set labelcount.

Parameters

label_count – int

Returns

OrderShipment

set_order_id(order_id: int) → merchantapi.model.OrderShipment

Set order_id.

Parameters

order_id – int

Returns

OrderShipment

set_ship_date(ship_date: int) → merchantapi.model.OrderShipment

Set ship_date.

Parameters

ship_date – int

Returns

OrderShipment

set_status(status: int) → merchantapi.model.OrderShipment

Set status.

Parameters

status – int

Returns

OrderShipment

set_tracking_link(tracking_link: str) → merchantapi.model.OrderShipment

Set tracklink.

Parameters

tracking_link – string

Returns

OrderShipment

set_tracking_number(tracking_number: str) → merchantapi.model.OrderShipment

Set tracknum.

Parameters

tracking_number – string

Returns

OrderShipment

set_tracking_type(tracking_type: str) → merchantapi.model.OrderShipment

Set tracktype.

Parameters

tracking_type – string

Returns

OrderShipment

set_weight(weight: float) → merchantapi.model.OrderShipment

Set weight.

Parameters

weight – int

Returns

OrderShipment

class merchantapi.model.OrderShipmentUpdate(data: dict = None)

Bases: merchantapi.abstract.Model

get_cost() → float

Get cost.

Returns

float

get_mark_shipped() → bool

Get mark_shipped.

Returns

bool

get_shipment_id() → int

Get shpmnt_id.

Returns

int

get_tracking_number() → str

Get tracknum.

Returns

string

get_tracking_type() → str

Get tracktype.

Returns

string

set_cost(cost: float) → merchantapi.model.OrderShipmentUpdate

Set cost.

Parameters

cost – int

Returns

OrderShipmentUpdate

set_mark_shipped(mark_shipped: bool) → merchantapi.model.OrderShipmentUpdate

Set mark_shipped.

Parameters

mark_shipped – bool

Returns

OrderShipmentUpdate

set_shipment_id(shipment_id: int) → merchantapi.model.OrderShipmentUpdate

Set shpmnt_id.

Parameters

shipment_id – int

Returns

OrderShipmentUpdate

set_tracking_number(tracking_number: str) → merchantapi.model.OrderShipmentUpdate

Set tracknum.

Parameters

tracking_number – string

Returns

OrderShipmentUpdate

set_tracking_type(tracking_type: str) → merchantapi.model.OrderShipmentUpdate

Set tracktype.

Parameters

tracking_type – string

Returns

OrderShipmentUpdate

class merchantapi.model.OrderTotal(data: dict = None)

Bases: merchantapi.abstract.Model

get_formatted_total() → str

Get formatted_total.

Returns

string

get_total() → float

Get total.

Returns

float

class merchantapi.model.PaymentCardType(data: dict = None)

Bases: merchantapi.abstract.Model

get_cvv() → bool

Get cvv.

Returns

bool

get_id() → int

Get id.

Returns

int

get_lengths() → str

Get lengths.

Returns

string

get_prefixes() → str

Get prefixes.

Returns

string

get_type() → str

Get type.

Returns

string

class merchantapi.model.PaymentMethod(data: dict = None)

Bases: merchantapi.abstract.Model

get_method_code() → str

Get method_code.

Returns

string

get_method_name() → str

Get method_name.

Returns

string

get_mivapay() → bool

Get mivapay.

Returns

bool

get_module_api() → float

Get module_api.

Returns

float

get_module_id() → int

Get module_id.

Returns

int

get_order_payment_card()

Get orderpaymentcard.

Returns

OrderPaymentCard|None

get_payment_card()

Get paymentcard.

Returns

CustomerPaymentCard|None

get_payment_card_type()

Get paymentcardtype.

Returns

PaymentCardType|None

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.PriceGroup(data: dict = None)

Bases: merchantapi.abstract.Model

ELIGIBILITY_ALL = 'A'

ELIGIBILITY_COUPON = 'C'

ELIGIBILITY_CUSTOMER = 'X'

ELIGIBILITY_LOGGED_IN = 'L'

get_basket_maximum_quantity() → int

Get bmx_quan.

Returns

int

get_basket_maximum_subtotal() → float

Get bmx_subtot.

Returns

float

get_basket_maximum_weight() → float

Get bmx_weight.

Returns

float

get_basket_minimum_quantity() → int

Get bmn_quan.

Returns

int

get_basket_minimum_subtotal() → float

Get bmn_subtot.

Returns

float

get_basket_minimum_weight() → float

Get bmn_weight.

Returns

float

get_capabilities()

Get capabilities.

Returns

DiscountModuleCapabilities|None

get_customer_scope() → str

Get custscope.

Returns

string

get_date_time_end() → int

Get dt_end.

Returns

int

get_date_time_start() → int

Get dt_start.

Returns

int

get_description() → str

Get descrip.

Returns

string

get_discount() → float

Get discount.

Returns

float

get_display() → bool

Get display.

Returns

bool

get_exclusion() → bool

Get exclusion.

Returns

bool

get_id() → int

Get id.

Returns

int

get_markup() → float

Get markup.

Returns

float

get_maximum_quantity() → int

Get qmx_quan.

Returns

int

get_maximum_subtotal() → float

Get qmx_subtot.

Returns

float

get_maximum_weight() → float

Get qmx_weight.

Returns

float

get_minimum_quantity() → int

Get qmn_quan.

Returns

int

get_minimum_subtotal() → float

Get qmn_subtot.

Returns

float

get_minimum_weight() → float

Get qmn_weight.

Returns

float

get_module()

Get module.

Returns

Module|None

get_name() → str

Get name.

Returns

string

get_priority() → int

Get priority.

Returns

int

set_basket_maximum_quantity(basket_maximum_quantity: int) → merchantapi.model.PriceGroup

Set bmx_quan.

Parameters

basket_maximum_quantity – int

Returns

PriceGroup

set_basket_maximum_subtotal(basket_maximum_subtotal: float) → merchantapi.model.PriceGroup

Set bmx_subtot.

Parameters

basket_maximum_subtotal – int

Returns

PriceGroup

set_basket_maximum_weight(basket_maximum_weight: float) → merchantapi.model.PriceGroup

Set bmx_weight.

Parameters

basket_maximum_weight – int

Returns

PriceGroup

set_basket_minimum_quantity(basket_minimum_quantity: int) → merchantapi.model.PriceGroup

Set bmn_quan.

Parameters

basket_minimum_quantity – int

Returns

PriceGroup

set_basket_minimum_subtotal(basket_minimum_subtotal: float) → merchantapi.model.PriceGroup

Set bmn_subtot.

Parameters

basket_minimum_subtotal – int

Returns

PriceGroup

set_basket_minimum_weight(basket_minimum_weight: float) → merchantapi.model.PriceGroup

Set bmn_weight.

Parameters

basket_minimum_weight – int

Returns

PriceGroup

set_customer_scope(customer_scope: str) → merchantapi.model.PriceGroup

Set custscope.

Parameters

customer_scope – string

Returns

PriceGroup

set_date_time_end(date_time_end)

Set dt_end.

Parameters

date_time_end – int

Returns

PriceGroup

set_date_time_start(date_time_start)

Set dt_start.

Parameters

date_time_start – int

Returns

PriceGroup

set_description(description: str) → merchantapi.model.PriceGroup

Set descrip.

Parameters

description – string

Returns

PriceGroup

set_discount(discount: float) → merchantapi.model.PriceGroup

Set discount.

Parameters

discount – int

Returns

PriceGroup

set_display(display: bool) → merchantapi.model.PriceGroup

Set display.

Parameters

display – bool

Returns

PriceGroup

set_exclusion(exclusion: bool) → merchantapi.model.PriceGroup

Set exclusion.

Parameters

exclusion – bool

Returns

PriceGroup

set_maximum_quantity(maximum_quantity: int) → merchantapi.model.PriceGroup

Set qmx_quan.

Parameters

maximum_quantity – int

Returns

PriceGroup

set_maximum_subtotal(maximum_subtotal: float) → merchantapi.model.PriceGroup

Set qmx_subtot.

Parameters

maximum_subtotal – int

Returns

PriceGroup

set_maximum_weight(maximum_weight: float) → merchantapi.model.PriceGroup

Set qmx_weight.

Parameters

maximum_weight – int

Returns

PriceGroup

set_minimum_quantity(minimum_quantity: int) → merchantapi.model.PriceGroup

Set qmn_quan.

Parameters

minimum_quantity – int

Returns

PriceGroup

set_minimum_subtotal(minimum_subtotal: float) → merchantapi.model.PriceGroup

Set qmn_subtot.

Parameters

minimum_subtotal – int

Returns

PriceGroup

set_minimum_weight(minimum_weight: float) → merchantapi.model.PriceGroup

Set qmn_weight.

Parameters

minimum_weight – int

Returns

PriceGroup

set_module(module) → merchantapi.model.PriceGroup

Set module.

Parameters

module – Module|dict

Returns

PriceGroup

Raises

Exception –

set_priority(priority: int) → merchantapi.model.PriceGroup

Set priority.

Parameters

priority – int

Returns

PriceGroup

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.PriceGroupCustomer(data: dict = None)

Bases: merchantapi.model.Customer

get_assigned() → bool

Get assigned.

Returns

bool

class merchantapi.model.PriceGroupProduct(data: dict = None)

Bases: merchantapi.model.Product

get_assigned() → bool

Get assigned.

Returns

bool

class merchantapi.model.PrintQueue(data: dict = None)

Bases: merchantapi.abstract.Model

get_description() → str

Get descrip.

Returns

string

get_id() → int

Get id.

Returns

int

class merchantapi.model.PrintQueueJob(data: dict = None)

Bases: merchantapi.abstract.Model

get_date_time_created() → int

Get dt_created.

Returns

int

get_description() → str

Get descrip.

Returns

string

get_id() → int

Get id.

Returns

int

get_job_data() → str

Get job_data.

Returns

string

get_job_format() → str

Get job_fmt.

Returns

string

get_print_queue_description() → str

Get printqueue_descrip.

Returns

string

get_queue_id() → int

Get queue_id.

Returns

int

get_store_code() → str

Get store_code.

Returns

string

get_store_id() → int

Get store_id.

Returns

int

get_store_name() → str

Get store_name.

Returns

string

get_user_id() → int

Get user_id.

Returns

int

get_user_name() → str

Get user_name.

Returns

string

class merchantapi.model.Product(data: dict = None)

Bases: merchantapi.abstract.Model

get_active() → bool

Get active.

Returns

bool

get_attributes()

Get attributes.

Returns

List of ProductAttribute

get_canonical_category_code() → str

Get cancat_code.

Returns

string

get_categories()

Get categories.

Returns

List of Category

get_category_count() → int

Get catcount.

Returns

int

get_code() → str

Get code.

Returns

string

get_cost() → float

Get cost.

Returns

float

get_custom_field_values()

Get CustomField_Values.

Returns

CustomFieldValues|None

get_date_time_created() → int

Get dt_created.

Returns

int

get_date_time_update() → int

Get dt_updated.

Returns

int

get_description() → str

Get descrip.

Returns

string

get_formatted_cost() → str

Get formatted_cost.

Returns

string

get_formatted_price() → str

Get formatted_price.

Returns

string

get_id() → int

Get id.

Returns

int

get_image() → str

Get image.

Returns

string

get_name() → str

Get name.

Returns

string

get_page_code() → str

Get page_code.

Returns

string

get_page_title() → str

Get page_title.

Returns

string

get_price() → float

Get price.

Returns

float

get_product_image_data()

Get productimagedata.

Returns

List of ProductImageData

get_product_inventory() → int

Get product_inventory.

Returns

int

get_product_inventory_active() → bool

Get product_inventory_active.

Returns

bool

get_product_inventory_settings()

Get productinventorysettings.

Returns

ProductInventorySettings|None

get_product_shupping_rules()

Get productshippingrules.

Returns

ProductShippingRules|None

get_related_products()

Get relatedproducts.

Returns

List of RelatedProduct

get_sku() → str

Get sku.

Returns

string

get_taxable() → bool

Get taxable.

Returns

bool

get_thumbnail() → str

Get thumbnail.

Returns

string

get_uris()

Get uris.

Returns

List of Uri

get_weight() → float

Get weight.

Returns

float

set_active(active: bool) → merchantapi.model.Product

Set active.

Parameters

active – bool

Returns

Product

set_canonical_category_code(canonical_category_code: str) → merchantapi.model.Product

Set cancat_code.

Parameters

canonical_category_code – string

Returns

Product

set_code(code: str) → merchantapi.model.Product

Set code.

Parameters

code – string

Returns

Product

set_cost(cost: float) → merchantapi.model.Product

Set cost.

Parameters

cost – int

Returns

Product

set_custom_field_values(custom_field_values) → merchantapi.model.Product

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues|dict

Returns

Product

Raises

Exception –

set_description(description: str) → merchantapi.model.Product

Set descrip.

Parameters

description – string

Returns

Product

set_image(image: str) → merchantapi.model.Product

Set image.

Parameters

image – string

Returns

Product

set_name(name: str) → merchantapi.model.Product

Set name.

Parameters

name – string

Returns

Product

set_page_code(page_code: str) → merchantapi.model.Product

Set page_code.

Parameters

page_code – string

Returns

Product

set_page_title(page_title: str) → merchantapi.model.Product

Set page_title.

Parameters

page_title – string

Returns

Product

set_price(price: float) → merchantapi.model.Product

Set price.

Parameters

price – int

Returns

Product

set_product_inventory(product_inventory: int) → merchantapi.model.Product

Set product_inventory.

Parameters

product_inventory – int

Returns

Product

set_sku(sku: str) → merchantapi.model.Product

Set sku.

Parameters

sku – string

Returns

Product

set_taxable(taxable: bool) → merchantapi.model.Product

Set taxable.

Parameters

taxable – bool

Returns

Product

set_thumbnail(thumbnail: str) → merchantapi.model.Product

Set thumbnail.

Parameters

thumbnail – string

Returns

Product

set_weight(weight: float) → merchantapi.model.Product

Set weight.

Parameters

weight – int

Returns

Product

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.ProductAttribute(data: dict = None)

Bases: merchantapi.abstract.Model

get_attribute_template_id() → int

Get attemp_id.

Returns

int

get_code() → str

Get code.

Returns

string

get_cost() → float

Get cost.

Returns

float

get_default_id() → int

Get default_id.

Returns

int

get_display_order() → int

Get disp_order.

Returns

int

get_id() → int

Get id.

Returns

int

get_image() → str

Get image.

Returns

string

get_inventory() → bool

Get inventory.

Returns

bool

get_options()

Get options.

Returns

List of ProductOption

get_price() → float

Get price.

Returns

float

get_product_id() → int

Get product_id.

Returns

int

get_prompt() → str

Get prompt.

Returns

string

get_required() → bool

Get required.

Returns

bool

get_type() → str

Get type.

Returns

string

get_weight() → float

Get weight.

Returns

float

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.ProductImageData(data: dict = None)

Bases: merchantapi.abstract.Model

get_code() → str

Get code.

Returns

string

get_display_order() → int

Get disp_order.

Returns

int

get_height() → int

Get height.

Returns

int

get_id() → int

Get id.

Returns

int

get_image() → str

Get image.

Returns

string

get_image_id() → int

Get image_id.

Returns

int

get_product_id() → int

Get product_id.

Returns

int

get_type_description() → str

Get type_desc.

Returns

string

get_type_id() → int

Get type_id.

Returns

int

get_width() → int

Get width.

Returns

int

class merchantapi.model.ProductInventoryAdjustment(data: dict = None)

Bases: merchantapi.abstract.Model

get_adjustment() → float

Get adjustment.

Returns

float

get_product_code() → str

Get product_code.

Returns

string

get_product_id() → int

Get product_id.

Returns

int

get_product_sku() → str

Get product_sku.

Returns

string

set_adjustment(adjustment: float) → merchantapi.model.ProductInventoryAdjustment

Set adjustment.

Parameters

adjustment – int

Returns

ProductInventoryAdjustment

set_product_code(product_code: str) → merchantapi.model.ProductInventoryAdjustment

Set product_code.

Parameters

product_code – string

Returns

ProductInventoryAdjustment

set_product_id(product_id: int) → merchantapi.model.ProductInventoryAdjustment

Set product_id.

Parameters

product_id – int

Returns

ProductInventoryAdjustment

set_product_sku(product_sku: str) → merchantapi.model.ProductInventoryAdjustment

Set product_sku.

Parameters

product_sku – string

Returns

ProductInventoryAdjustment

class merchantapi.model.ProductInventorySettings(data: dict = None)

Bases: merchantapi.abstract.Model

get_active() → bool

Get active.

Returns

bool

get_hide_out_of_stock() → str

Get out_hide.

Returns

string

get_in_stock_message_long() → str

Get in_long.

Returns

string

get_in_stock_message_short() → str

Get in_short.

Returns

string

get_limited_stock_message() → str

Get ltd_long.

Returns

string

get_low_stock_level() → int

Get low_level.

Returns

int

get_low_stock_level_default() → bool

Get low_lvl_d.

Returns

bool

get_low_stock_message_long() → str

Get low_long.

Returns

string

get_low_stock_message_short() → str

Get low_short.

Returns

string

get_out_of_stock_level() → int

Get out_level.

Returns

int

get_out_of_stock_level_default() → bool

Get out_lvl_d.

Returns

bool

get_out_of_stock_message_long() → str

Get out_long.

Returns

string

get_out_of_stock_message_short() → str

Get out_short.

Returns

string

get_track_low_stock_level() → str

Get low_track.

Returns

string

get_track_out_of_stock_level() → str

Get out_track.

Returns

string

class merchantapi.model.ProductOption(data: dict = None)

Bases: merchantapi.abstract.Model

get_attemp_id() → int

Get attemp_id.

Returns

int

get_attmpat_id() → int

Get attmpat_id.

Returns

int

get_attribute_id() → int

Get attr_id.

Returns

int

get_code() → str

Get code.

Returns

string

get_cost() → float

Get cost.

Returns

float

get_display_order() → int

Get disp_order.

Returns

int

get_id() → int

Get id.

Returns

int

get_image() → str

Get image.

Returns

string

get_price() → float

Get price.

Returns

float

get_product_id() → int

Get product_id.

Returns

int

get_prompt() → str

Get prompt.

Returns

string

get_weight() → float

Get weight.

Returns

float

class merchantapi.model.ProductShippingMethod(data: dict = None)

Bases: merchantapi.abstract.Model

get_method_code() → str

Get meth_code.

Returns

string

get_module_code() → str

Get mod_code.

Returns

string

class merchantapi.model.ProductShippingRules(data: dict = None)

Bases: merchantapi.abstract.Model

add_method(method: merchantapi.model.ProductShippingMethod) → merchantapi.model.ProductShippingRules

Add a ProductShippingMethod.

Parameters

method – ProductShippingMethod

Returns

ProductShippingRules

get_height() → float

Get height.

Returns

float

get_length() → float

Get length.

Returns

float

get_limit_methods() → bool

Get limitmeths.

Returns

bool

get_methods()

Get methods.

Returns

List of ProductShippingMethod

get_own_package() → bool

Get ownpackage.

Returns

bool

get_product_id() → int

Get product_id.

Returns

int

get_width() → float

Get width.

Returns

float

set_methods(methods: list) → merchantapi.model.ProductShippingRules

Set methods.

Parameters

methods – List of ProductShippingMethod

Raises

Exception –

Returns

ProductShippingRules

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.ProductSubscriptionTerm(data: dict = None)

Bases: merchantapi.abstract.Model

TERM_FREQUENCY_ANNUALLY = 'annually'

TERM_FREQUENCY_BIWEEKLY = 'biweekly'

TERM_FREQUENCY_DAILY = 'daily'

TERM_FREQUENCY_DATES = 'dates'

TERM_FREQUENCY_FIXED_MONTHLY = 'fixedmonthly'

TERM_FREQUENCY_FIXED_WEEKLY = 'fixedweekly'

TERM_FREQUENCY_N_DAYS = 'n'

TERM_FREQUENCY_N_MONTHS = 'n_months'

TERM_FREQUENCY_QUARTERLY = 'quarterly'

TERM_FREQUENCY_SEMIANNUALLY = 'semiannually'

TERM_FREQUENCY_WEEKLY = 'weekly'

get_description() → str

Get descrip.

Returns

string

get_fixed_day_of_month() → int

Get fixed_dom.

Returns

int

get_fixed_day_of_week() → int

Get fixed_dow.

Returns

int

get_frequency() → str

Get frequency.

Returns

string

get_id() → int

Get id.

Returns

int

get_n() → int

Get n.

Returns

int

get_product_id() → int

Get product_id.

Returns

int

get_subscription_count() → int

Get sub_count.

Returns

int

get_term() → int

Get term.

Returns

int

class merchantapi.model.ProductVariant(data: dict = None)

Bases: merchantapi.abstract.Model

get_dimensions()

Get dimensions.

Returns

List of ProductVariantDimension

get_parts()

Get parts.

Returns

List of ProductVariantPart

get_product_id() → int

Get product_id.

Returns

int

get_variant_id() → int

Get variant_id.

Returns

int

to_dict() → dict

Reduce the model to a dict.

class merchantapi.model.ProductVariantDimension(data: dict = None)

Bases: merchantapi.abstract.Model

get_attribute_id() → int

Get attr_id.

Returns

int

get_attribute_template_attribute_id() → int

Get attmpat_id.

Returns

int

get_option_code() → str

Get option_code.

Returns

string

get_option_id() → int

Get option_id.

Returns

int

class merchantapi.model.ProductVariantExclusion(data: dict = None)

Bases: merchantapi.abstract.Model

get_attribute_id() → int

Get attr_id.

Returns

int

get_attribute_template_id() → int

Get attmpat_id.

Returns

int

get_option_id() → int

Get option_id.

Returns

int

set_attribute_id(attribute_id: int) → merchantapi.model.ProductVariantExclusion

Set attr_id.

Parameters

attribute_id – int

Returns

ProductVariantExclusion

set_attribute_template_id(attribute_template_id: int) → merchantapi.model.ProductVariantExclusion

Set attmpat_id.

Parameters

attribute_template_id – int

Returns

ProductVariantExclusion

set_option_id(option_id: int) → merchantapi.model.ProductVariantExclusion

Set option_id.

Parameters

option_id – int

Returns

ProductVariantExclusion

class merchantapi.model.ProductVariantLimit(data: dict = None)

Bases: merchantapi.abstract.Model

get_attribute_id() → int

Get attr_id.

Returns

int

get_attribute_template_id() → int

Get attmpat_id.

Returns

int

get_option_id() → int

Get option_id.

Returns

int

set_attribute_id(attribute_id: int) → merchantapi.model.ProductVariantLimit

Set attr_id.

Parameters

attribute_id – int

Returns

ProductVariantLimit

set_attribute_template_id(attribute_template_id: int) → merchantapi.model.ProductVariantLimit

Set attmpat_id.

Parameters

attribute_template_id – int

Returns

ProductVariantLimit

set_option_id(option_id: int) → merchantapi.model.ProductVariantLimit

Set option_id.

Parameters

option_id – int

Returns

ProductVariantLimit

class merchantapi.model.ProductVariantPart(data: dict = None)

Bases: merchantapi.abstract.Model

get_product_code() → str

Get product_code.

Returns

string

get_product_id() → int

Get product_id.

Returns

int

get_product_name() → str

Get product_name.

Returns

string

get_quantity() → int

Get quantity.

Returns

int

class merchantapi.model.ProvisionMessage(data: dict = None)

Bases: merchantapi.abstract.Model

get_date_time_stamp() → str

Get dtstamp.

Returns

string

get_line_number() → int

Get lineno.

Returns

int

get_message() → str

Get message.

Returns

string

get_tag() → str

Get tag.

Returns

string

class merchantapi.model.RelatedProduct(data: dict = None)

Bases: merchantapi.abstract.Model

get_active() → bool

Get active.

Returns

bool

get_code() → str

Get code.

Returns

string

get_cost() → float

Get cost.

Returns

float

get_date_time_created() → int

Get dt_created.

Returns

int

get_date_time_updated() → int

Get dt_updated.

Returns

int

get_formatted_cost() → str

Get formatted_cost.

Returns

string

get_formatted_price() → str

Get formatted_price.

Returns

string

get_id() → int

Get id.

Returns

int

get_image() → str

Get image.

Returns

string

get_name() → str

Get name.

Returns

string

get_page_title() → str

Get page_title.

Returns

string

get_price() → float

Get price.

Returns

float

get_sku() → str

Get sku.

Returns

string

get_taxable() → bool

Get taxable.

Returns

bool

get_thumbnail() → str

Get thumbnail.

Returns

string

get_weight() → float

Get weight.

Returns

float

set_active(active: bool) → merchantapi.model.RelatedProduct

Set active.

Parameters

active – bool

Returns

RelatedProduct

set_code(code: str) → merchantapi.model.RelatedProduct

Set code.

Parameters

code – string

Returns

RelatedProduct

set_cost(cost: float) → merchantapi.model.RelatedProduct

Set cost.

Parameters

cost – int

Returns

RelatedProduct

set_image(image: str) → merchantapi.model.RelatedProduct

Set image.

Parameters

image – string

Returns

RelatedProduct

set_name(name: str) → merchantapi.model.RelatedProduct

Set name.

Parameters

name – string

Returns

RelatedProduct

set_page_title(page_title: str) → merchantapi.model.RelatedProduct

Set page_title.

Parameters

page_title – string

Returns

RelatedProduct

set_price(price: float) → merchantapi.model.RelatedProduct

Set price.

Parameters

price – int

Returns

RelatedProduct

set_sku(sku: str) → merchantapi.model.RelatedProduct

Set sku.

Parameters

sku – string

Returns

RelatedProduct

set_taxable(taxable: bool) → merchantapi.model.RelatedProduct

Set taxable.

Parameters

taxable – bool

Returns

RelatedProduct

set_thumbnail(thumbnail: str) → merchantapi.model.RelatedProduct

Set thumbnail.

Parameters

thumbnail – string

Returns

RelatedProduct

set_weight(weight: float) → merchantapi.model.RelatedProduct

Set weight.

Parameters

weight – int

Returns

RelatedProduct

class merchantapi.model.Subscription(data: dict = None)

Bases: merchantapi.abstract.Model

get_address_id() → int

Get addr_id.

Returns

int

get_cancel_date() → str

Get cncldate.

Returns

string

get_customer_id() → int

Get cust_id.

Returns

int

get_customer_payment_card_id() → int

Get custpc_id.

Returns

int

get_first_date() → int

Get firstdate.

Returns

int

get_formatted_shipping() → str

Get formatted_shipping.

Returns

string

get_formatted_subtotal() → str

Get formatted_subtotal.

Returns

string

get_formatted_tax() → str

Get formatted_tax.

Returns

string

get_formatted_total() → str

Get formatted_total.

Returns

string

get_id() → int

Get id.

Returns

int

get_last_date() → int

Get lastdate.

Returns

int

get_line_id() → int

Get line_id.

Returns

int

get_message() → str

Get message.

Returns

string

get_next_date() → int

Get nextdate.

Returns

int

get_order_id() → int

Get order_id.

Returns

int

get_product_id() → int

Get product_id.

Returns

int

get_quantity() → int

Get quantity.

Returns

int

get_ship_data() → str

Get ship_data.

Returns

string

get_ship_id() → int

Get ship_id.

Returns

int

get_shipping() → float

Get shipping.

Returns

float

get_status() → str

Get status.

Returns

string

get_subscription_term_id() → int

Get subterm_id.

Returns

int

get_subtotal() → float

Get subtotal.

Returns

float

get_tax() → float

Get tax.

Returns

float

get_term_processed() → int

Get termproc.

Returns

int

get_term_remaining() → int

Get termrem.

Returns

int

get_total() → float

Get total.

Returns

float

set_cancel_date(cancel_date: str) → merchantapi.model.Subscription

Set cncldate.

Parameters

cancel_date – string

Returns

Subscription

class merchantapi.model.SubscriptionOption(data: dict = None)

Bases: merchantapi.abstract.Model

get_attribute_code() → str

Get attr_code.

Returns

string

get_subscription_id() → int

Get subscrp_id.

Returns

int

get_template_code() → str

Get templ_code.

Returns

string

get_value() → str

Get value.

Returns

string

class merchantapi.model.Uri(data: dict = None)

Bases: merchantapi.abstract.Model

get_canonical() → bool

Get canonical.

Returns

bool

get_category_id() → int

Get cat_id.

Returns

int

get_feed_id() → int

Get feed_id.

Returns

int

get_id() → int

Get id.

Returns

int

get_page_id() → int

Get page_id.

Returns

int

get_product_id() → int

Get product_id.

Returns

int

get_screen() → str

Get screen.

Returns

string

get_status() → int

Get status.

Returns

int

get_store_id() → int

Get store_id.

Returns

int

get_uri() → str

Get uri.

Returns

string

merchantapi.multicall module

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with self source code.

$Id: multicall.py 77667 2019-08-29 19:18:13Z gidriss $

class merchantapi.multicall.MultiCallOperation(request: merchantapi.abstract.Request = None, shared_data: dict = None)

Bases: object

add_request(request: merchantapi.abstract.Request) → merchantapi.multicall.MultiCallOperation

Add a request iteration.

Parameters

request – Request

Returns

MultiCallOperation

Raises

Exception –

add_requests(requests: list) → merchantapi.multicall.MultiCallOperation

Add an array of requests iterations.

Parameters

requests – list[Request]

Returns

MultiCallOperation

Raises

Exception –

add_shared_data(key: str, value) → merchantapi.multicall.MultiCallOperation

Add a shared data value for key.

Parameters

• key – str

• value – str|dict

Returns

MultiCallOperation

get_function()

get_requests()

Get the request iterations.

Returns

list

get_shared_data() → dict

Get the shared data between the iterations.

Returns

dict

set_requests(requests: list) → merchantapi.multicall.MultiCallOperation

Set and override the request iterations.

Parameters

requests – list[Request]

Returns

MultiCallOperation

Raises

Exception –

set_shared_data(values: dict) → merchantapi.multicall.MultiCallOperation

Set the shared data object.

Parameters

values – dict

Returns

MultiCallOperation

to_dict() → dict

Reduce the operation to a dict

Returns

dict

class merchantapi.multicall.MultiCallRequest(client: merchantapi.abstract.Client = None, requests: list = None)

Bases: merchantapi.abstract.Request

add_operation(operation: merchantapi.multicall.MultiCallOperation) → merchantapi.multicall.MultiCallRequest

Add a operation to be sent.

Parameters

operation – MultiCallOperation

Returns

MultiCallRequest

add_operations(operations: list) → merchantapi.multicall.MultiCallRequest

Add an array of operations.

Param

list[MultiCallOperation]

Returns

MultiCallRequest

add_request(request: merchantapi.abstract.Request) → merchantapi.multicall.MultiCallRequest

Add a request to be sent.

Parameters

request – Request

Returns

MultiCallRequest

add_requests(requests: list)

Add requests to be sent.

:param :Array requests :returns:MultiCallRequest

create_response(data: dict) → merchantapi.multicall.MultiCallResponse

Parameters

data – dict

get_requests() → list

Get the requests to be sent.

Returns

list

operation(request: merchantapi.abstract.Request = None, shared_data: dict = None) → merchantapi.multicall.MultiCallOperation

Create an operation instance and add it to the request.

Parameters

• request – Request|list[Request]|None

• shared_data – dict|None

Returns

send() → merchantapi.multicall.MultiCallResponse

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_requests(requests: list)

Set and override the requests to be sent.

Parameters

requests – list

Returns

MultiCallRequest

to_dict() → dict

Reduce the request to an Object.

Returns

dict

class merchantapi.multicall.MultiCallResponse(request: merchantapi.multicall.MultiCallRequest, data: dict)

Bases: merchantapi.abstract.Response

add_response(response: merchantapi.abstract.Response) → merchantapi.multicall.MultiCallResponse

Add a response.

Parameters

response – Response

Returns

MultiCallResponse

Raises

Exception –

get_responses() → list

Get the responses.

Returns

list[Response]

is_success()

Returns

bool

set_responses(responses: list) → merchantapi.multicall.MultiCallResponse

Set and overwrite the responses.

Parameters

responses – list[Response]

Returns

MultiCallResponse

merchantapi.request module

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

$Id: request.py 77709 2019-08-30 16:41:54Z gidriss $

class merchantapi.request.AvailabilityGroupBusinessAccountUpdateAssigned(client: merchantapi.client.Client = None, availability_group: merchantapi.model.AvailabilityGroup = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.AvailabilityGroupBusinessAccountUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_availability_group_id() → int

Get AvailabilityGroup_ID.

Returns

int

get_availability_group_name() → str

Get AvailabilityGroup_Name.

Returns

str

get_business_account_id() → int

Get BusinessAccount_ID.

Returns

int

get_business_account_title() → str

Get BusinessAccount_Title.

Returns

str

get_edit_availability_group() → str

Get Edit_AvailabilityGroup.

Returns

str

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.AvailabilityGroupBusinessAccountUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.AvailabilityGroupBusinessAccountUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

AvailabilityGroupBusinessAccountUpdateAssigned

set_availability_group_id(availability_group_id: int) → merchantapi.request.AvailabilityGroupBusinessAccountUpdateAssigned

Set AvailabilityGroup_ID.

Parameters

availability_group_id – int

Returns

AvailabilityGroupBusinessAccountUpdateAssigned

set_availability_group_name(availability_group_name: str) → merchantapi.request.AvailabilityGroupBusinessAccountUpdateAssigned

Set AvailabilityGroup_Name.

Parameters

availability_group_name – str

Returns

AvailabilityGroupBusinessAccountUpdateAssigned

set_business_account_id(business_account_id: int) → merchantapi.request.AvailabilityGroupBusinessAccountUpdateAssigned

Set BusinessAccount_ID.

Parameters

business_account_id – int

Returns

AvailabilityGroupBusinessAccountUpdateAssigned

set_business_account_title(business_account_title: str) → merchantapi.request.AvailabilityGroupBusinessAccountUpdateAssigned

Set BusinessAccount_Title.

Parameters

business_account_title – str

Returns

AvailabilityGroupBusinessAccountUpdateAssigned

set_edit_availability_group(edit_availability_group: str) → merchantapi.request.AvailabilityGroupBusinessAccountUpdateAssigned

Set Edit_AvailabilityGroup.

Parameters

edit_availability_group – str

Returns

AvailabilityGroupBusinessAccountUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.AvailabilityGroupCustomerUpdateAssigned(client: merchantapi.client.Client = None, availability_group: merchantapi.model.AvailabilityGroup = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.AvailabilityGroupCustomerUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_availability_group_id() → int

Get AvailabilityGroup_ID.

Returns

int

get_availability_group_name() → str

Get AvailabilityGroup_Name.

Returns

str

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_edit_availability_group() → str

Get Edit_AvailabilityGroup.

Returns

str

get_edit_customer() → str

Get Edit_Customer.

Returns

str

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.AvailabilityGroupCustomerUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.AvailabilityGroupCustomerUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

AvailabilityGroupCustomerUpdateAssigned

set_availability_group_id(availability_group_id: int) → merchantapi.request.AvailabilityGroupCustomerUpdateAssigned

Set AvailabilityGroup_ID.

Parameters

availability_group_id – int

Returns

AvailabilityGroupCustomerUpdateAssigned

set_availability_group_name(availability_group_name: str) → merchantapi.request.AvailabilityGroupCustomerUpdateAssigned

Set AvailabilityGroup_Name.

Parameters

availability_group_name – str

Returns

AvailabilityGroupCustomerUpdateAssigned

set_customer_id(customer_id: int) → merchantapi.request.AvailabilityGroupCustomerUpdateAssigned

Set Customer_ID.

Parameters

customer_id – int

Returns

AvailabilityGroupCustomerUpdateAssigned

set_customer_login(customer_login: str) → merchantapi.request.AvailabilityGroupCustomerUpdateAssigned

Set Customer_Login.

Parameters

customer_login – str

Returns

AvailabilityGroupCustomerUpdateAssigned

set_edit_availability_group(edit_availability_group: str) → merchantapi.request.AvailabilityGroupCustomerUpdateAssigned

Set Edit_AvailabilityGroup.

Parameters

edit_availability_group – str

Returns

AvailabilityGroupCustomerUpdateAssigned

set_edit_customer(edit_customer: str) → merchantapi.request.AvailabilityGroupCustomerUpdateAssigned

Set Edit_Customer.

Parameters

edit_customer – str

Returns

AvailabilityGroupCustomerUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.AvailabilityGroupListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

available_search_fields = ['id', 'name']

available_sort_fields = ['id', 'name']

create_response(data) → merchantapi.request.AvailabilityGroupListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.AvailabilityGroupListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned(client: merchantapi.client.Client = None, availability_group: merchantapi.model.AvailabilityGroup = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_availability_group_id() → int

Get AvailabilityGroup_ID.

Returns

int

get_availability_group_name() → str

Get AvailabilityGroup_Name.

Returns

str

get_edit_availability_group() → str

Get Edit_AvailabilityGroup.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_method_code() → str

Get Method_Code.

Returns

str

get_module_code() → str

Get Module_Code.

Returns

str

get_payment_card_type_id() → int

Get PaymentCardType_ID.

Returns

int

send() → merchantapi.response.AvailabilityGroupPaymentMethodUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

AvailabilityGroupPaymentMethodUpdateAssigned

set_availability_group_id(availability_group_id: int) → merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned

Set AvailabilityGroup_ID.

Parameters

availability_group_id – int

Returns

AvailabilityGroupPaymentMethodUpdateAssigned

set_availability_group_name(availability_group_name: str) → merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned

Set AvailabilityGroup_Name.

Parameters

availability_group_name – str

Returns

AvailabilityGroupPaymentMethodUpdateAssigned

set_edit_availability_group(edit_availability_group: str) → merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned

Set Edit_AvailabilityGroup.

Parameters

edit_availability_group – str

Returns

AvailabilityGroupPaymentMethodUpdateAssigned

set_method_code(method_code: str) → merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned

Set Method_Code.

Parameters

method_code – str

Returns

AvailabilityGroupPaymentMethodUpdateAssigned

set_module_code(module_code: str) → merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned

Set Module_Code.

Parameters

module_code – str

Returns

AvailabilityGroupPaymentMethodUpdateAssigned

set_payment_card_type_id(payment_card_type_id: int) → merchantapi.request.AvailabilityGroupPaymentMethodUpdateAssigned

Set PaymentCardType_ID.

Parameters

payment_card_type_id – int

Returns

AvailabilityGroupPaymentMethodUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.AvailabilityGroupProductUpdateAssigned(client: merchantapi.client.Client = None, availability_group: merchantapi.model.AvailabilityGroup = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_availability_group_id() → int

Get AvailabilityGroup_ID.

Returns

int

get_availability_group_name() → str

Get AvailabilityGroup_Name.

Returns

str

get_edit_availability_group() → str

Get Edit_AvailabilityGroup.

Returns

str

get_edit_product() → str

Get Edit_Product.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_product_code() → str

Get Product_Code.

Returns

str

get_product_id() → int

Get Product_ID.

Returns

int

get_product_sku() → str

Get Product_SKU.

Returns

str

send() → merchantapi.response.AvailabilityGroupProductUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

AvailabilityGroupProductUpdateAssigned

set_availability_group_id(availability_group_id: int) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Set AvailabilityGroup_ID.

Parameters

availability_group_id – int

Returns

AvailabilityGroupProductUpdateAssigned

set_availability_group_name(availability_group_name: str) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Set AvailabilityGroup_Name.

Parameters

availability_group_name – str

Returns

AvailabilityGroupProductUpdateAssigned

set_edit_availability_group(edit_availability_group: str) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Set Edit_AvailabilityGroup.

Parameters

edit_availability_group – str

Returns

AvailabilityGroupProductUpdateAssigned

set_edit_product(edit_product: str) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Set Edit_Product.

Parameters

edit_product – str

Returns

AvailabilityGroupProductUpdateAssigned

set_product_code(product_code: str) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Set Product_Code.

Parameters

product_code – str

Returns

AvailabilityGroupProductUpdateAssigned

set_product_id(product_id: int) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Set Product_ID.

Parameters

product_id – int

Returns

AvailabilityGroupProductUpdateAssigned

set_product_sku(product_sku: str) → merchantapi.request.AvailabilityGroupProductUpdateAssigned

Set Product_SKU.

Parameters

product_sku – str

Returns

AvailabilityGroupProductUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.AvailabilityGroupShippingMethodUpdateAssigned(client: merchantapi.client.Client = None, availability_group: merchantapi.model.AvailabilityGroup = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.AvailabilityGroupShippingMethodUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_availability_group_id() → int

Get AvailabilityGroup_ID.

Returns

int

get_availability_group_name() → str

Get AvailabilityGroup_Name.

Returns

str

get_edit_availability_group() → str

Get Edit_AvailabilityGroup.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_method_code() → str

Get Method_Code.

Returns

str

get_module_code() → str

Get Module_Code.

Returns

str

send() → merchantapi.response.AvailabilityGroupShippingMethodUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.AvailabilityGroupShippingMethodUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

AvailabilityGroupShippingMethodUpdateAssigned

set_availability_group_id(availability_group_id: int) → merchantapi.request.AvailabilityGroupShippingMethodUpdateAssigned

Set AvailabilityGroup_ID.

Parameters

availability_group_id – int

Returns

AvailabilityGroupShippingMethodUpdateAssigned

set_availability_group_name(availability_group_name: str) → merchantapi.request.AvailabilityGroupShippingMethodUpdateAssigned

Set AvailabilityGroup_Name.

Parameters

availability_group_name – str

Returns

AvailabilityGroupShippingMethodUpdateAssigned

set_edit_availability_group(edit_availability_group: str) → merchantapi.request.AvailabilityGroupShippingMethodUpdateAssigned

Set Edit_AvailabilityGroup.

Parameters

edit_availability_group – str

Returns

AvailabilityGroupShippingMethodUpdateAssigned

set_method_code(method_code: str) → merchantapi.request.AvailabilityGroupShippingMethodUpdateAssigned

Set Method_Code.

Parameters

method_code – str

Returns

AvailabilityGroupShippingMethodUpdateAssigned

set_module_code(module_code: str) → merchantapi.request.AvailabilityGroupShippingMethodUpdateAssigned

Set Module_Code.

Parameters

module_code – str

Returns

AvailabilityGroupShippingMethodUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CategoryDelete(client: merchantapi.client.Client = None, category: merchantapi.model.Category = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CategoryDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_category_code() → str

Get Category_Code.

Returns

str

get_category_id() → int

Get Category_ID.

Returns

int

get_edit_category() → str

Get Edit_Category.

Returns

str

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CategoryDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_category_code(category_code: str) → merchantapi.request.CategoryDelete

Set Category_Code.

Parameters

category_code – str

Returns

CategoryDelete

set_category_id(category_id: int) → merchantapi.request.CategoryDelete

Set Category_ID.

Parameters

category_id – int

Returns

CategoryDelete

set_edit_category(edit_category: str) → merchantapi.request.CategoryDelete

Set Edit_Category.

Parameters

edit_category – str

Returns

CategoryDelete

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CategoryInsert(client: merchantapi.client.Client = None, category: merchantapi.model.Category = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CategoryInsert

Create a response object from the response data

Parameters

data –

Returns

Response

get_category_active() → bool

Get Category_Active.

Returns

bool

get_category_alternate_display_page() → str

Get Category_Alternate_Display_Page.

Returns

str

get_category_code() → str

Get Category_Code.

Returns

str

get_category_name() → str

Get Category_Name.

Returns

str

get_category_page_title() → str

Get Category_Page_Title.

Returns

str

get_category_parent_category() → str

Get Category_Parent_Category.

Returns

str

get_custom_field_values() → merchantapi.model.CustomFieldValues

Get CustomField_Values.

Returns

CustomFieldValues}|None

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CategoryInsert

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_category_active(category_active: bool) → merchantapi.request.CategoryInsert

Set Category_Active.

Parameters

category_active – bool

Returns

CategoryInsert

set_category_alternate_display_page(category_alternate_display_page: str) → merchantapi.request.CategoryInsert

Set Category_Alternate_Display_Page.

Parameters

category_alternate_display_page – str

Returns

CategoryInsert

set_category_code(category_code: str) → merchantapi.request.CategoryInsert

Set Category_Code.

Parameters

category_code – str

Returns

CategoryInsert

set_category_name(category_name: str) → merchantapi.request.CategoryInsert

Set Category_Name.

Parameters

category_name – str

Returns

CategoryInsert

set_category_page_title(category_page_title: str) → merchantapi.request.CategoryInsert

Set Category_Page_Title.

Parameters

category_page_title – str

Returns

CategoryInsert

set_category_parent_category(category_parent_category: str) → merchantapi.request.CategoryInsert

Set Category_Parent_Category.

Parameters

category_parent_category – str

Returns

CategoryInsert

set_custom_field_values(custom_field_values: merchantapi.model.CustomFieldValues) → merchantapi.request.CategoryInsert

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues}|None

Raises

Exception –

Returns

CategoryInsert

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CategoryListLoadParent(client: merchantapi.client.Client = None, category: merchantapi.model.Category = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CategoryListLoadParent

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_parent_id() → int

Get Parent_ID.

Returns

int

send() → merchantapi.response.CategoryListLoadParent

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_parent_id(parent_id: int) → merchantapi.request.CategoryListLoadParent

Set Parent_ID.

Parameters

parent_id – int

Returns

CategoryListLoadParent

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CategoryListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

CATEGORY_SHOW_ACTIVE = 'Active'

CATEGORY_SHOW_ALL = 'All'

available_custom_filters = {'Category_Show': ['All', 'Active']}

available_search_fields = ['id', 'code', 'name', 'page_title', 'parent_category', 'page_code', 'dt_created', 'dt_updated', 'depth']

available_sort_fields = ['id', 'code', 'name', 'page_title', 'active', 'page_code', 'parent_category', 'disp_order', 'dt_created', 'dt_updated', 'depth']

create_response(data) → merchantapi.request.CategoryListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CategoryListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.CategoryProductListLoadQuery(client: merchantapi.client.Client = None, category: merchantapi.model.Category = None)

Bases: merchantapi.request.ProductListLoadQuery

create_response(data) → merchantapi.request.CategoryProductListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_category_code() → str

Get Category_Code.

Returns

str

get_category_id() → int

Get Category_ID.

Returns

int

get_edit_category() → str

Get Edit_Category.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_unassigned() → bool

Get Unassigned.

Returns

bool

send() → merchantapi.response.CategoryProductListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.CategoryProductListLoadQuery

Set Assigned.

Parameters

assigned – bool

Returns

CategoryProductListLoadQuery

set_category_code(category_code: str) → merchantapi.request.CategoryProductListLoadQuery

Set Category_Code.

Parameters

category_code – str

Returns

CategoryProductListLoadQuery

set_category_id(category_id: int) → merchantapi.request.CategoryProductListLoadQuery

Set Category_ID.

Parameters

category_id – int

Returns

CategoryProductListLoadQuery

set_edit_category(edit_category: str) → merchantapi.request.CategoryProductListLoadQuery

Set Edit_Category.

Parameters

edit_category – str

Returns

CategoryProductListLoadQuery

set_unassigned(unassigned: bool) → merchantapi.request.CategoryProductListLoadQuery

Set Unassigned.

Parameters

unassigned – bool

Returns

CategoryProductListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CategoryProductUpdateAssigned(client: merchantapi.client.Client = None, category: merchantapi.model.Category = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CategoryProductUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_category_code() → str

Get Category_Code.

Returns

str

get_category_id() → int

Get Category_ID.

Returns

int

get_edit_category() → str

Get Edit_Category.

Returns

str

get_edit_product() → str

Get Edit_Product.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_product_code() → str

Get Product_Code.

Returns

str

get_product_id() → int

Get Product_ID.

Returns

int

get_product_sku() → str

Get Product_SKU.

Returns

str

send() → merchantapi.response.CategoryProductUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.CategoryProductUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

CategoryProductUpdateAssigned

set_category_code(category_code: str) → merchantapi.request.CategoryProductUpdateAssigned

Set Category_Code.

Parameters

category_code – str

Returns

CategoryProductUpdateAssigned

set_category_id(category_id: int) → merchantapi.request.CategoryProductUpdateAssigned

Set Category_ID.

Parameters

category_id – int

Returns

CategoryProductUpdateAssigned

set_edit_category(edit_category: str) → merchantapi.request.CategoryProductUpdateAssigned

Set Edit_Category.

Parameters

edit_category – str

Returns

CategoryProductUpdateAssigned

set_edit_product(edit_product: str) → merchantapi.request.CategoryProductUpdateAssigned

Set Edit_Product.

Parameters

edit_product – str

Returns

CategoryProductUpdateAssigned

set_product_code(product_code: str) → merchantapi.request.CategoryProductUpdateAssigned

Set Product_Code.

Parameters

product_code – str

Returns

CategoryProductUpdateAssigned

set_product_id(product_id: int) → merchantapi.request.CategoryProductUpdateAssigned

Set Product_ID.

Parameters

product_id – int

Returns

CategoryProductUpdateAssigned

set_product_sku(product_sku: str) → merchantapi.request.CategoryProductUpdateAssigned

Set Product_SKU.

Parameters

product_sku – str

Returns

CategoryProductUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CategoryUpdate(client: merchantapi.client.Client = None, category: merchantapi.model.Category = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CategoryUpdate

Create a response object from the response data

Parameters

data –

Returns

Response

get_category_active() → bool

Get Category_Active.

Returns

bool

get_category_alternate_display_page() → str

Get Category_Alternate_Display_Page.

Returns

str

get_category_code() → str

Get Category_Code.

Returns

str

get_category_id() → int

Get Category_ID.

Returns

int

get_category_name() → str

Get Category_Name.

Returns

str

get_category_page_title() → str

Get Category_Page_Title.

Returns

str

get_category_parent_category() → str

Get Category_Parent_Category.

Returns

str

get_custom_field_values() → merchantapi.model.CustomFieldValues

Get CustomField_Values.

Returns

CustomFieldValues}|None

get_edit_category() → str

Get Edit_Category.

Returns

str

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CategoryUpdate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_category_active(category_active: bool) → merchantapi.request.CategoryUpdate

Set Category_Active.

Parameters

category_active – bool

Returns

CategoryUpdate

set_category_alternate_display_page(category_alternate_display_page: str) → merchantapi.request.CategoryUpdate

Set Category_Alternate_Display_Page.

Parameters

category_alternate_display_page – str

Returns

CategoryUpdate

set_category_code(category_code: str) → merchantapi.request.CategoryUpdate

Set Category_Code.

Parameters

category_code – str

Returns

CategoryUpdate

set_category_id(category_id: int) → merchantapi.request.CategoryUpdate

Set Category_ID.

Parameters

category_id – int

Returns

CategoryUpdate

set_category_name(category_name: str) → merchantapi.request.CategoryUpdate

Set Category_Name.

Parameters

category_name – str

Returns

CategoryUpdate

set_category_page_title(category_page_title: str) → merchantapi.request.CategoryUpdate

Set Category_Page_Title.

Parameters

category_page_title – str

Returns

CategoryUpdate

set_category_parent_category(category_parent_category: str) → merchantapi.request.CategoryUpdate

Set Category_Parent_Category.

Parameters

category_parent_category – str

Returns

CategoryUpdate

set_custom_field_values(custom_field_values: merchantapi.model.CustomFieldValues) → merchantapi.request.CategoryUpdate

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues}|None

Raises

Exception –

Returns

CategoryUpdate

set_edit_category(edit_category: str) → merchantapi.request.CategoryUpdate

Set Edit_Category.

Parameters

edit_category – str

Returns

CategoryUpdate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CouponInsert(client: merchantapi.client.Client = None, coupon: merchantapi.model.Coupon = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CouponInsert

Create a response object from the response data

Parameters

data –

Returns

Response

get_active() → bool

Get Active.

Returns

bool

get_code() → str

Get Code.

Returns

str

get_customer_scope() → str

Get CustomerScope.

Returns

str

get_date_time_end() → int

Get DateTime_End.

Returns

int

get_date_time_start() → int

Get DateTime_Start.

Returns

int

get_description() → str

Get Description.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_max_per() → int

Get Max_Per.

Returns

int

get_max_use() → int

Get Max_Use.

Returns

int

get_price_group_id() → int

Get PriceGroup_ID.

Returns

int

send() → merchantapi.response.CouponInsert

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_active(active: bool) → merchantapi.request.CouponInsert

Set Active.

Parameters

active – bool

Returns

CouponInsert

set_code(code: str) → merchantapi.request.CouponInsert

Set Code.

Parameters

code – str

Returns

CouponInsert

set_customer_scope(customer_scope: str) → merchantapi.request.CouponInsert

Set CustomerScope.

Parameters

customer_scope – str

Returns

CouponInsert

set_date_time_end(date_time_end: int) → merchantapi.request.CouponInsert

Set DateTime_End.

Parameters

date_time_end – int

Returns

CouponInsert

set_date_time_start(date_time_start: int) → merchantapi.request.CouponInsert

Set DateTime_Start.

Parameters

date_time_start – int

Returns

CouponInsert

set_description(description: str) → merchantapi.request.CouponInsert

Set Description.

Parameters

description – str

Returns

CouponInsert

set_max_per(max_per: int) → merchantapi.request.CouponInsert

Set Max_Per.

Parameters

max_per – int

Returns

CouponInsert

set_max_use(max_use: int) → merchantapi.request.CouponInsert

Set Max_Use.

Parameters

max_use – int

Returns

CouponInsert

set_price_group_id(price_group_id: int) → merchantapi.request.CouponInsert

Set PriceGroup_ID.

Parameters

price_group_id – int

Returns

CouponInsert

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CouponListDelete(client: merchantapi.client.Client = None)

Bases: merchantapi.abstract.Request

add_coupon(coupon: merchantapi.model.Coupon) → merchantapi.request.CouponListDelete

Add Coupon model.

Parameters

coupon – Coupon

Raises

Exception –

Returns

CouponListDelete

add_coupon_id(coupon_id) → merchantapi.request.CouponListDelete

Add Coupon_IDs.

Parameters

coupon_id – int

Returns

{CouponListDelete}

create_response(data) → merchantapi.request.CouponListDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_coupon_ids()

Get Coupon_IDs.

Returns

list

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CouponListDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CouponListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

available_search_fields = ['id', 'code', 'descrip', 'custscope', 'dt_start', 'dt_end', 'max_use', 'max_per', 'active', 'use_count']

available_sort_fields = ['id', 'code', 'descrip', 'custscope', 'dt_start', 'dt_end', 'max_use', 'max_per', 'active', 'use_count']

create_response(data) → merchantapi.request.CouponListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CouponListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.CouponPriceGroupListLoadQuery(client: merchantapi.client.Client = None, coupon: merchantapi.model.Coupon = None)

Bases: merchantapi.request.PriceGroupListLoadQuery

create_response(data) → merchantapi.request.CouponPriceGroupListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_coupon_code() → str

Get Coupon_Code.

Returns

str

get_coupon_id() → int

Get Coupon_ID.

Returns

int

get_edit_coupon() → str

Get Edit_Coupon.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_unassigned() → bool

Get Unassigned.

Returns

bool

send() → merchantapi.response.CouponPriceGroupListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.CouponPriceGroupListLoadQuery

Set Assigned.

Parameters

assigned – bool

Returns

CouponPriceGroupListLoadQuery

set_coupon_code(coupon_code: str) → merchantapi.request.CouponPriceGroupListLoadQuery

Set Coupon_Code.

Parameters

coupon_code – str

Returns

CouponPriceGroupListLoadQuery

set_coupon_id(coupon_id: int) → merchantapi.request.CouponPriceGroupListLoadQuery

Set Coupon_ID.

Parameters

coupon_id – int

Returns

CouponPriceGroupListLoadQuery

set_edit_coupon(edit_coupon: str) → merchantapi.request.CouponPriceGroupListLoadQuery

Set Edit_Coupon.

Parameters

edit_coupon – str

Returns

CouponPriceGroupListLoadQuery

set_unassigned(unassigned: bool) → merchantapi.request.CouponPriceGroupListLoadQuery

Set Unassigned.

Parameters

unassigned – bool

Returns

CouponPriceGroupListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CouponPriceGroupUpdateAssigned(client: merchantapi.client.Client = None, coupon: merchantapi.model.Coupon = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CouponPriceGroupUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_coupon_code() → str

Get Coupon_Code.

Returns

str

get_coupon_id() → int

Get Coupon_ID.

Returns

int

get_edit_coupon() → str

Get Edit_Coupon.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_price_group_id() → int

Get PriceGroup_ID.

Returns

int

get_price_group_name() → str

Get PriceGroup_Name.

Returns

str

send() → merchantapi.response.CouponPriceGroupUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.CouponPriceGroupUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

CouponPriceGroupUpdateAssigned

set_coupon_code(coupon_code: str) → merchantapi.request.CouponPriceGroupUpdateAssigned

Set Coupon_Code.

Parameters

coupon_code – str

Returns

CouponPriceGroupUpdateAssigned

set_coupon_id(coupon_id: int) → merchantapi.request.CouponPriceGroupUpdateAssigned

Set Coupon_ID.

Parameters

coupon_id – int

Returns

CouponPriceGroupUpdateAssigned

set_edit_coupon(edit_coupon: str) → merchantapi.request.CouponPriceGroupUpdateAssigned

Set Edit_Coupon.

Parameters

edit_coupon – str

Returns

CouponPriceGroupUpdateAssigned

set_price_group_id(price_group_id: int) → merchantapi.request.CouponPriceGroupUpdateAssigned

Set PriceGroup_ID.

Parameters

price_group_id – int

Returns

CouponPriceGroupUpdateAssigned

set_price_group_name(price_group_name: str) → merchantapi.request.CouponPriceGroupUpdateAssigned

Set PriceGroup_Name.

Parameters

price_group_name – str

Returns

CouponPriceGroupUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CouponUpdate(client: merchantapi.client.Client = None, coupon: merchantapi.model.Coupon = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CouponUpdate

Create a response object from the response data

Parameters

data –

Returns

Response

get_active() → bool

Get Active.

Returns

bool

get_code() → str

Get Code.

Returns

str

get_coupon_code() → str

Get Coupon_Code.

Returns

str

get_coupon_id() → int

Get Coupon_ID.

Returns

int

get_customer_scope() → str

Get CustomerScope.

Returns

str

get_date_time_end() → int

Get DateTime_End.

Returns

int

get_date_time_start() → int

Get DateTime_Start.

Returns

int

get_description() → str

Get Description.

Returns

str

get_edit_coupon() → str

Get Edit_Coupon.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_max_per() → int

Get Max_Per.

Returns

int

get_max_use() → int

Get Max_Use.

Returns

int

send() → merchantapi.response.CouponUpdate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_active(active: bool) → merchantapi.request.CouponUpdate

Set Active.

Parameters

active – bool

Returns

CouponUpdate

set_code(code: str) → merchantapi.request.CouponUpdate

Set Code.

Parameters

code – str

Returns

CouponUpdate

set_coupon_code(coupon_code: str) → merchantapi.request.CouponUpdate

Set Coupon_Code.

Parameters

coupon_code – str

Returns

CouponUpdate

set_coupon_id(coupon_id: int) → merchantapi.request.CouponUpdate

Set Coupon_ID.

Parameters

coupon_id – int

Returns

CouponUpdate

set_customer_scope(customer_scope: str) → merchantapi.request.CouponUpdate

Set CustomerScope.

Parameters

customer_scope – str

Returns

CouponUpdate

set_date_time_end(date_time_end: int) → merchantapi.request.CouponUpdate

Set DateTime_End.

Parameters

date_time_end – int

Returns

CouponUpdate

set_date_time_start(date_time_start: int) → merchantapi.request.CouponUpdate

Set DateTime_Start.

Parameters

date_time_start – int

Returns

CouponUpdate

set_description(description: str) → merchantapi.request.CouponUpdate

Set Description.

Parameters

description – str

Returns

CouponUpdate

set_edit_coupon(edit_coupon: str) → merchantapi.request.CouponUpdate

Set Edit_Coupon.

Parameters

edit_coupon – str

Returns

CouponUpdate

set_max_per(max_per: int) → merchantapi.request.CouponUpdate

Set Max_Per.

Parameters

max_per – int

Returns

CouponUpdate

set_max_use(max_use: int) → merchantapi.request.CouponUpdate

Set Max_Use.

Parameters

max_use – int

Returns

CouponUpdate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CustomerAddressListLoadQuery(client: merchantapi.client.Client = None, customer: merchantapi.model.Customer = None)

Bases: merchantapi.listquery.ListQueryRequest

available_search_fields = ['cust_id', 'id', 'descrip', 'fname', 'lname', 'email', 'comp', 'phone', 'fax', 'addr1', 'addr2', 'city', 'state', 'zip', 'cntry', 'resdntl']

available_sort_fields = ['cust_id', 'id', 'descrip', 'fname', 'lname', 'email', 'comp', 'phone', 'fax', 'addr1', 'addr2', 'city', 'state', 'zip', 'cntry', 'resdntl']

create_response(data) → merchantapi.request.CustomerAddressListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_edit_customer() → str

Get Edit_Customer.

Returns

str

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CustomerAddressListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_customer_id(customer_id: int) → merchantapi.request.CustomerAddressListLoadQuery

Set Customer_ID.

Parameters

customer_id – int

Returns

CustomerAddressListLoadQuery

set_customer_login(customer_login: str) → merchantapi.request.CustomerAddressListLoadQuery

Set Customer_Login.

Parameters

customer_login – str

Returns

CustomerAddressListLoadQuery

set_edit_customer(edit_customer: str) → merchantapi.request.CustomerAddressListLoadQuery

Set Edit_Customer.

Parameters

edit_customer – str

Returns

CustomerAddressListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CustomerDelete(client: merchantapi.client.Client = None, customer: merchantapi.model.Customer = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CustomerDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_edit_customer() → str

Get Edit_Customer.

Returns

str

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CustomerDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_customer_id(customer_id: int) → merchantapi.request.CustomerDelete

Set Customer_ID.

Parameters

customer_id – int

Returns

CustomerDelete

set_customer_login(customer_login: str) → merchantapi.request.CustomerDelete

Set Customer_Login.

Parameters

customer_login – str

Returns

CustomerDelete

set_edit_customer(edit_customer: str) → merchantapi.request.CustomerDelete

Set Edit_Customer.

Parameters

edit_customer – str

Returns

CustomerDelete

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CustomerInsert(client: merchantapi.client.Client = None, customer: merchantapi.model.Customer = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CustomerInsert

Create a response object from the response data

Parameters

data –

Returns

Response

get_custom_field_values() → merchantapi.model.CustomFieldValues

Get CustomField_Values.

Returns

CustomFieldValues}|None

get_customer_bill_address1() → str

Get Customer_BillAddress1.

Returns

str

get_customer_bill_address2() → str

Get Customer_BillAddress2.

Returns

str

get_customer_bill_city() → str

Get Customer_BillCity.

Returns

str

get_customer_bill_company() → str

Get Customer_BillCompany.

Returns

str

get_customer_bill_country() → str

Get Customer_BillCountry.

Returns

str

get_customer_bill_email() → str

Get Customer_BillEmail.

Returns

str

get_customer_bill_fax() → str

Get Customer_BillFax.

Returns

str

get_customer_bill_first_name() → str

Get Customer_BillFirstName.

Returns

str

get_customer_bill_last_name() → str

Get Customer_BillLastName.

Returns

str

get_customer_bill_phone() → str

Get Customer_BillPhone.

Returns

str

get_customer_bill_state() → str

Get Customer_BillState.

Returns

str

get_customer_bill_zip() → str

Get Customer_BillZip.

Returns

str

get_customer_business_account() → str

Get Customer_BusinessAccount.

Returns

str

get_customer_login() → str

Get Customer_Login.

Returns

str

get_customer_password() → str

Get Customer_Password.

Returns

str

get_customer_password_email() → str

Get Customer_PasswordEmail.

Returns

str

get_customer_ship_address1() → str

Get Customer_ShipAddress1.

Returns

str

get_customer_ship_address2() → str

Get Customer_ShipAddress2.

Returns

str

get_customer_ship_city() → str

Get Customer_ShipCity.

Returns

str

get_customer_ship_company() → str

Get Customer_ShipCompany.

Returns

str

get_customer_ship_country() → str

Get Customer_ShipCountry.

Returns

str

get_customer_ship_email() → str

Get Customer_ShipEmail.

Returns

str

get_customer_ship_fax() → str

Get Customer_ShipFax.

Returns

str

get_customer_ship_first_name() → str

Get Customer_ShipFirstName.

Returns

str

get_customer_ship_last_name() → str

Get Customer_ShipLastName.

Returns

str

get_customer_ship_phone() → str

Get Customer_ShipPhone.

Returns

str

get_customer_ship_residential() → bool

Get Customer_ShipResidential.

Returns

bool

get_customer_ship_state() → str

Get Customer_ShipState.

Returns

str

get_customer_ship_zip() → str

Get Customer_ShipZip.

Returns

str

get_customer_tax_exempt() → bool

Get Customer_Tax_Exempt.

Returns

bool

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CustomerInsert

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_custom_field_values(custom_field_values: merchantapi.model.CustomFieldValues) → merchantapi.request.CustomerInsert

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues}|None

Raises

Exception –

Returns

CustomerInsert

set_customer_bill_address1(customer_bill_address1: str) → merchantapi.request.CustomerInsert

Set Customer_BillAddress1.

Parameters

customer_bill_address1 – str

Returns

CustomerInsert

set_customer_bill_address2(customer_bill_address2: str) → merchantapi.request.CustomerInsert

Set Customer_BillAddress2.

Parameters

customer_bill_address2 – str

Returns

CustomerInsert

set_customer_bill_city(customer_bill_city: str) → merchantapi.request.CustomerInsert

Set Customer_BillCity.

Parameters

customer_bill_city – str

Returns

CustomerInsert

set_customer_bill_company(customer_bill_company: str) → merchantapi.request.CustomerInsert

Set Customer_BillCompany.

Parameters

customer_bill_company – str

Returns

CustomerInsert

set_customer_bill_country(customer_bill_country: str) → merchantapi.request.CustomerInsert

Set Customer_BillCountry.

Parameters

customer_bill_country – str

Returns

CustomerInsert

set_customer_bill_email(customer_bill_email: str) → merchantapi.request.CustomerInsert

Set Customer_BillEmail.

Parameters

customer_bill_email – str

Returns

CustomerInsert

set_customer_bill_fax(customer_bill_fax: str) → merchantapi.request.CustomerInsert

Set Customer_BillFax.

Parameters

customer_bill_fax – str

Returns

CustomerInsert

set_customer_bill_first_name(customer_bill_first_name: str) → merchantapi.request.CustomerInsert

Set Customer_BillFirstName.

Parameters

customer_bill_first_name – str

Returns

CustomerInsert

set_customer_bill_last_name(customer_bill_last_name: str) → merchantapi.request.CustomerInsert

Set Customer_BillLastName.

Parameters

customer_bill_last_name – str

Returns

CustomerInsert

set_customer_bill_phone(customer_bill_phone: str) → merchantapi.request.CustomerInsert

Set Customer_BillPhone.

Parameters

customer_bill_phone – str

Returns

CustomerInsert

set_customer_bill_state(customer_bill_state: str) → merchantapi.request.CustomerInsert

Set Customer_BillState.

Parameters

customer_bill_state – str

Returns

CustomerInsert

set_customer_bill_zip(customer_bill_zip: str) → merchantapi.request.CustomerInsert

Set Customer_BillZip.

Parameters

customer_bill_zip – str

Returns

CustomerInsert

set_customer_business_account(customer_business_account: str) → merchantapi.request.CustomerInsert

Set Customer_BusinessAccount.

Parameters

customer_business_account – str

Returns

CustomerInsert

set_customer_login(customer_login: str) → merchantapi.request.CustomerInsert

Set Customer_Login.

Parameters

customer_login – str

Returns

CustomerInsert

set_customer_password(customer_password: str) → merchantapi.request.CustomerInsert

Set Customer_Password.

Parameters

customer_password – str

Returns

CustomerInsert

set_customer_password_email(customer_password_email: str) → merchantapi.request.CustomerInsert

Set Customer_PasswordEmail.

Parameters

customer_password_email – str

Returns

CustomerInsert

set_customer_ship_address1(customer_ship_address1: str) → merchantapi.request.CustomerInsert

Set Customer_ShipAddress1.

Parameters

customer_ship_address1 – str

Returns

CustomerInsert

set_customer_ship_address2(customer_ship_address2: str) → merchantapi.request.CustomerInsert

Set Customer_ShipAddress2.

Parameters

customer_ship_address2 – str

Returns

CustomerInsert

set_customer_ship_city(customer_ship_city: str) → merchantapi.request.CustomerInsert

Set Customer_ShipCity.

Parameters

customer_ship_city – str

Returns

CustomerInsert

set_customer_ship_company(customer_ship_company: str) → merchantapi.request.CustomerInsert

Set Customer_ShipCompany.

Parameters

customer_ship_company – str

Returns

CustomerInsert

set_customer_ship_country(customer_ship_country: str) → merchantapi.request.CustomerInsert

Set Customer_ShipCountry.

Parameters

customer_ship_country – str

Returns

CustomerInsert

set_customer_ship_email(customer_ship_email: str) → merchantapi.request.CustomerInsert

Set Customer_ShipEmail.

Parameters

customer_ship_email – str

Returns

CustomerInsert

set_customer_ship_fax(customer_ship_fax: str) → merchantapi.request.CustomerInsert

Set Customer_ShipFax.

Parameters

customer_ship_fax – str

Returns

CustomerInsert

set_customer_ship_first_name(customer_ship_first_name: str) → merchantapi.request.CustomerInsert

Set Customer_ShipFirstName.

Parameters

customer_ship_first_name – str

Returns

CustomerInsert

set_customer_ship_last_name(customer_ship_last_name: str) → merchantapi.request.CustomerInsert

Set Customer_ShipLastName.

Parameters

customer_ship_last_name – str

Returns

CustomerInsert

set_customer_ship_phone(customer_ship_phone: str) → merchantapi.request.CustomerInsert

Set Customer_ShipPhone.

Parameters

customer_ship_phone – str

Returns

CustomerInsert

set_customer_ship_residential(customer_ship_residential: bool) → merchantapi.request.CustomerInsert

Set Customer_ShipResidential.

Parameters

customer_ship_residential – bool

Returns

CustomerInsert

set_customer_ship_state(customer_ship_state: str) → merchantapi.request.CustomerInsert

Set Customer_ShipState.

Parameters

customer_ship_state – str

Returns

CustomerInsert

set_customer_ship_zip(customer_ship_zip: str) → merchantapi.request.CustomerInsert

Set Customer_ShipZip.

Parameters

customer_ship_zip – str

Returns

CustomerInsert

set_customer_tax_exempt(customer_tax_exempt: bool) → merchantapi.request.CustomerInsert

Set Customer_Tax_Exempt.

Parameters

customer_tax_exempt – bool

Returns

CustomerInsert

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CustomerListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

available_search_fields = ['id', 'login', 'pw_email', 'ship_fname', 'ship_lname', 'ship_email', 'ship_comp', 'ship_phone', 'ship_fax', 'ship_addr1', 'ship_addr2', 'ship_city', 'ship_state', 'ship_zip', 'ship_cntry', 'ship_res', 'bill_fname', 'bill_lname', 'bill_email', 'bill_comp', 'bill_phone', 'bill_fax', 'bill_addr1', 'bill_addr2', 'bill_city', 'bill_state', 'bill_zip', 'bill_cntry', 'business_title', 'note_count', 'dt_created', 'dt_login', 'credit']

available_sort_fields = ['id', 'login', 'pw_email', 'ship_fname', 'ship_lname', 'ship_email', 'ship_comp', 'ship_phone', 'ship_fax', 'ship_addr1', 'ship_addr2', 'ship_city', 'ship_state', 'ship_zip', 'ship_cntry', 'ship_res', 'bill_fname', 'bill_lname', 'bill_email', 'bill_comp', 'bill_phone', 'bill_fax', 'bill_addr1', 'bill_addr2', 'bill_city', 'bill_state', 'bill_zip', 'bill_cntry', 'business_title', 'note_count', 'dt_created', 'dt_login', 'credit']

create_response(data) → merchantapi.request.CustomerListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CustomerListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.CustomerPaymentCardListLoadQuery(client: merchantapi.client.Client = None, customer: merchantapi.model.Customer = None)

Bases: merchantapi.listquery.ListQueryRequest

available_search_fields = ['fname', 'lname', 'exp_month', 'exp_year', 'lastfour', 'lastused', 'type', 'addr1', 'addr2', 'city', 'state', 'zip', 'cntry', 'refcount', 'mod_code', 'meth_code', 'id']

available_sort_fields = ['fname', 'lname', 'expires', 'lastfour', 'lastused', 'type', 'addr1', 'addr2', 'city', 'state', 'zip', 'cntry', 'refcount', 'mod_code', 'meth_code', 'id']

create_response(data) → merchantapi.request.CustomerPaymentCardListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_edit_customer() → str

Get Edit_Customer.

Returns

str

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CustomerPaymentCardListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_customer_id(customer_id: int) → merchantapi.request.CustomerPaymentCardListLoadQuery

Set Customer_ID.

Parameters

customer_id – int

Returns

CustomerPaymentCardListLoadQuery

set_customer_login(customer_login: str) → merchantapi.request.CustomerPaymentCardListLoadQuery

Set Customer_Login.

Parameters

customer_login – str

Returns

CustomerPaymentCardListLoadQuery

set_edit_customer(edit_customer: str) → merchantapi.request.CustomerPaymentCardListLoadQuery

Set Edit_Customer.

Parameters

edit_customer – str

Returns

CustomerPaymentCardListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CustomerPaymentCardRegister(client: merchantapi.client.Client = None, customer: merchantapi.model.Customer = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CustomerPaymentCardRegister

Create a response object from the response data

Parameters

data –

Returns

Response

get_address1() → str

Get Address1.

Returns

str

get_address2() → str

Get Address2.

Returns

str

get_card_number() → str

Get CardNumber.

Returns

str

get_card_type() → str

Get CardType.

Returns

str

get_city() → str

Get City.

Returns

str

get_country() → str

Get Country.

Returns

str

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_edit_customer() → str

Get Edit_Customer.

Returns

str

get_expiration_month() → int

Get ExpirationMonth.

Returns

int

get_expiration_year() → int

Get ExpirationYear.

Returns

int

get_first_name() → str

Get FirstName.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_last_name() → str

Get LastName.

Returns

str

get_state() → str

Get State.

Returns

str

get_zip() → str

Get Zip.

Returns

str

send() → merchantapi.response.CustomerPaymentCardRegister

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_address1(address1: str) → merchantapi.request.CustomerPaymentCardRegister

Set Address1.

Parameters

address1 – str

Returns

CustomerPaymentCardRegister

set_address2(address2: str) → merchantapi.request.CustomerPaymentCardRegister

Set Address2.

Parameters

address2 – str

Returns

CustomerPaymentCardRegister

set_card_number(card_number: str) → merchantapi.request.CustomerPaymentCardRegister

Set CardNumber.

Parameters

card_number – str

Returns

CustomerPaymentCardRegister

set_card_type(card_type: str) → merchantapi.request.CustomerPaymentCardRegister

Set CardType.

Parameters

card_type – str

Returns

CustomerPaymentCardRegister

set_city(city: str) → merchantapi.request.CustomerPaymentCardRegister

Set City.

Parameters

city – str

Returns

CustomerPaymentCardRegister

set_country(country: str) → merchantapi.request.CustomerPaymentCardRegister

Set Country.

Parameters

country – str

Returns

CustomerPaymentCardRegister

set_customer_id(customer_id: int) → merchantapi.request.CustomerPaymentCardRegister

Set Customer_ID.

Parameters

customer_id – int

Returns

CustomerPaymentCardRegister

set_customer_login(customer_login: str) → merchantapi.request.CustomerPaymentCardRegister

Set Customer_Login.

Parameters

customer_login – str

Returns

CustomerPaymentCardRegister

set_edit_customer(edit_customer: str) → merchantapi.request.CustomerPaymentCardRegister

Set Edit_Customer.

Parameters

edit_customer – str

Returns

CustomerPaymentCardRegister

set_expiration_month(expiration_month: int) → merchantapi.request.CustomerPaymentCardRegister

Set ExpirationMonth.

Parameters

expiration_month – int

Returns

CustomerPaymentCardRegister

set_expiration_year(expiration_year: int) → merchantapi.request.CustomerPaymentCardRegister

Set ExpirationYear.

Parameters

expiration_year – int

Returns

CustomerPaymentCardRegister

set_first_name(first_name: str) → merchantapi.request.CustomerPaymentCardRegister

Set FirstName.

Parameters

first_name – str

Returns

CustomerPaymentCardRegister

set_last_name(last_name: str) → merchantapi.request.CustomerPaymentCardRegister

Set LastName.

Parameters

last_name – str

Returns

CustomerPaymentCardRegister

set_state(state: str) → merchantapi.request.CustomerPaymentCardRegister

Set State.

Parameters

state – str

Returns

CustomerPaymentCardRegister

set_zip(zip: str) → merchantapi.request.CustomerPaymentCardRegister

Set Zip.

Parameters

zip – str

Returns

CustomerPaymentCardRegister

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CustomerPriceGroupListLoadQuery(client: merchantapi.client.Client = None, customer: merchantapi.model.Customer = None)

Bases: merchantapi.request.PriceGroupListLoadQuery

create_response(data) → merchantapi.request.CustomerPriceGroupListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_edit_customer() → str

Get Edit_Customer.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_unassigned() → bool

Get Unassigned.

Returns

bool

send() → merchantapi.response.CustomerPriceGroupListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.CustomerPriceGroupListLoadQuery

Set Assigned.

Parameters

assigned – bool

Returns

CustomerPriceGroupListLoadQuery

set_customer_id(customer_id: int) → merchantapi.request.CustomerPriceGroupListLoadQuery

Set Customer_ID.

Parameters

customer_id – int

Returns

CustomerPriceGroupListLoadQuery

set_customer_login(customer_login: str) → merchantapi.request.CustomerPriceGroupListLoadQuery

Set Customer_Login.

Parameters

customer_login – str

Returns

CustomerPriceGroupListLoadQuery

set_edit_customer(edit_customer: str) → merchantapi.request.CustomerPriceGroupListLoadQuery

Set Edit_Customer.

Parameters

edit_customer – str

Returns

CustomerPriceGroupListLoadQuery

set_unassigned(unassigned: bool) → merchantapi.request.CustomerPriceGroupListLoadQuery

Set Unassigned.

Parameters

unassigned – bool

Returns

CustomerPriceGroupListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.CustomerUpdate(client: merchantapi.client.Client = None, customer: merchantapi.model.Customer = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.CustomerUpdate

Create a response object from the response data

Parameters

data –

Returns

Response

get_custom_field_values() → merchantapi.model.CustomFieldValues

Get CustomField_Values.

Returns

CustomFieldValues}|None

get_customer_bill_address1() → str

Get Customer_BillAddress1.

Returns

str

get_customer_bill_address2() → str

Get Customer_BillAddress2.

Returns

str

get_customer_bill_city() → str

Get Customer_BillCity.

Returns

str

get_customer_bill_company() → str

Get Customer_BillCompany.

Returns

str

get_customer_bill_country() → str

Get Customer_BillCountry.

Returns

str

get_customer_bill_email() → str

Get Customer_BillEmail.

Returns

str

get_customer_bill_fax() → str

Get Customer_BillFax.

Returns

str

get_customer_bill_first_name() → str

Get Customer_BillFirstName.

Returns

str

get_customer_bill_last_name() → str

Get Customer_BillLastName.

Returns

str

get_customer_bill_phone() → str

Get Customer_BillPhone.

Returns

str

get_customer_bill_state() → str

Get Customer_BillState.

Returns

str

get_customer_bill_zip() → str

Get Customer_BillZip.

Returns

str

get_customer_business_account() → str

Get Customer_BusinessAccount.

Returns

str

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_customer_password() → str

Get Customer_Password.

Returns

str

get_customer_password_email() → str

Get Customer_PasswordEmail.

Returns

str

get_customer_ship_address1() → str

Get Customer_ShipAddress1.

Returns

str

get_customer_ship_address2() → str

Get Customer_ShipAddress2.

Returns

str

get_customer_ship_city() → str

Get Customer_ShipCity.

Returns

str

get_customer_ship_company() → str

Get Customer_ShipCompany.

Returns

str

get_customer_ship_country() → str

Get Customer_ShipCountry.

Returns

str

get_customer_ship_email() → str

Get Customer_ShipEmail.

Returns

str

get_customer_ship_fax() → str

Get Customer_ShipFax.

Returns

str

get_customer_ship_first_name() → str

Get Customer_ShipFirstName.

Returns

str

get_customer_ship_last_name() → str

Get Customer_ShipLastName.

Returns

str

get_customer_ship_phone() → str

Get Customer_ShipPhone.

Returns

str

get_customer_ship_residential() → bool

Get Customer_ShipResidential.

Returns

bool

get_customer_ship_state() → str

Get Customer_ShipState.

Returns

str

get_customer_ship_zip() → str

Get Customer_ShipZip.

Returns

str

get_customer_tax_exempt() → str

Get Customer_Tax_Exempt.

Returns

str

get_edit_customer() → str

Get Edit_Customer.

Returns

str

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.CustomerUpdate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_custom_field_values(custom_field_values: merchantapi.model.CustomFieldValues) → merchantapi.request.CustomerUpdate

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues}|None

Raises

Exception –

Returns

CustomerUpdate

set_customer_bill_address1(customer_bill_address1: str) → merchantapi.request.CustomerUpdate

Set Customer_BillAddress1.

Parameters

customer_bill_address1 – str

Returns

CustomerUpdate

set_customer_bill_address2(customer_bill_address2: str) → merchantapi.request.CustomerUpdate

Set Customer_BillAddress2.

Parameters

customer_bill_address2 – str

Returns

CustomerUpdate

set_customer_bill_city(customer_bill_city: str) → merchantapi.request.CustomerUpdate

Set Customer_BillCity.

Parameters

customer_bill_city – str

Returns

CustomerUpdate

set_customer_bill_company(customer_bill_company: str) → merchantapi.request.CustomerUpdate

Set Customer_BillCompany.

Parameters

customer_bill_company – str

Returns

CustomerUpdate

set_customer_bill_country(customer_bill_country: str) → merchantapi.request.CustomerUpdate

Set Customer_BillCountry.

Parameters

customer_bill_country – str

Returns

CustomerUpdate

set_customer_bill_email(customer_bill_email: str) → merchantapi.request.CustomerUpdate

Set Customer_BillEmail.

Parameters

customer_bill_email – str

Returns

CustomerUpdate

set_customer_bill_fax(customer_bill_fax: str) → merchantapi.request.CustomerUpdate

Set Customer_BillFax.

Parameters

customer_bill_fax – str

Returns

CustomerUpdate

set_customer_bill_first_name(customer_bill_first_name: str) → merchantapi.request.CustomerUpdate

Set Customer_BillFirstName.

Parameters

customer_bill_first_name – str

Returns

CustomerUpdate

set_customer_bill_last_name(customer_bill_last_name: str) → merchantapi.request.CustomerUpdate

Set Customer_BillLastName.

Parameters

customer_bill_last_name – str

Returns

CustomerUpdate

set_customer_bill_phone(customer_bill_phone: str) → merchantapi.request.CustomerUpdate

Set Customer_BillPhone.

Parameters

customer_bill_phone – str

Returns

CustomerUpdate

set_customer_bill_state(customer_bill_state: str) → merchantapi.request.CustomerUpdate

Set Customer_BillState.

Parameters

customer_bill_state – str

Returns

CustomerUpdate

set_customer_bill_zip(customer_bill_zip: str) → merchantapi.request.CustomerUpdate

Set Customer_BillZip.

Parameters

customer_bill_zip – str

Returns

CustomerUpdate

set_customer_business_account(customer_business_account: str) → merchantapi.request.CustomerUpdate

Set Customer_BusinessAccount.

Parameters

customer_business_account – str

Returns

CustomerUpdate

set_customer_id(customer_id: int) → merchantapi.request.CustomerUpdate

Set Customer_ID.

Parameters

customer_id – int

Returns

CustomerUpdate

set_customer_login(customer_login: str) → merchantapi.request.CustomerUpdate

Set Customer_Login.

Parameters

customer_login – str

Returns

CustomerUpdate

set_customer_password(customer_password: str) → merchantapi.request.CustomerUpdate

Set Customer_Password.

Parameters

customer_password – str

Returns

CustomerUpdate

set_customer_password_email(customer_password_email: str) → merchantapi.request.CustomerUpdate

Set Customer_PasswordEmail.

Parameters

customer_password_email – str

Returns

CustomerUpdate

set_customer_ship_address1(customer_ship_address1: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipAddress1.

Parameters

customer_ship_address1 – str

Returns

CustomerUpdate

set_customer_ship_address2(customer_ship_address2: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipAddress2.

Parameters

customer_ship_address2 – str

Returns

CustomerUpdate

set_customer_ship_city(customer_ship_city: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipCity.

Parameters

customer_ship_city – str

Returns

CustomerUpdate

set_customer_ship_company(customer_ship_company: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipCompany.

Parameters

customer_ship_company – str

Returns

CustomerUpdate

set_customer_ship_country(customer_ship_country: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipCountry.

Parameters

customer_ship_country – str

Returns

CustomerUpdate

set_customer_ship_email(customer_ship_email: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipEmail.

Parameters

customer_ship_email – str

Returns

CustomerUpdate

set_customer_ship_fax(customer_ship_fax: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipFax.

Parameters

customer_ship_fax – str

Returns

CustomerUpdate

set_customer_ship_first_name(customer_ship_first_name: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipFirstName.

Parameters

customer_ship_first_name – str

Returns

CustomerUpdate

set_customer_ship_last_name(customer_ship_last_name: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipLastName.

Parameters

customer_ship_last_name – str

Returns

CustomerUpdate

set_customer_ship_phone(customer_ship_phone: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipPhone.

Parameters

customer_ship_phone – str

Returns

CustomerUpdate

set_customer_ship_residential(customer_ship_residential: bool) → merchantapi.request.CustomerUpdate

Set Customer_ShipResidential.

Parameters

customer_ship_residential – bool

Returns

CustomerUpdate

set_customer_ship_state(customer_ship_state: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipState.

Parameters

customer_ship_state – str

Returns

CustomerUpdate

set_customer_ship_zip(customer_ship_zip: str) → merchantapi.request.CustomerUpdate

Set Customer_ShipZip.

Parameters

customer_ship_zip – str

Returns

CustomerUpdate

set_customer_tax_exempt(customer_tax_exempt: str) → merchantapi.request.CustomerUpdate

Set Customer_Tax_Exempt.

Parameters

customer_tax_exempt – str

Returns

CustomerUpdate

set_edit_customer(edit_customer: str) → merchantapi.request.CustomerUpdate

Set Edit_Customer.

Parameters

edit_customer – str

Returns

CustomerUpdate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.Module(client: merchantapi.client.Client = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.Module

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_module_code() → str

Get Module_Code.

Returns

str

get_module_fields()

Get Module_Fields.

Returns

dict

get_module_function() → str

Get Module_Function.

Returns

str

send() → merchantapi.response.Module

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_module_code(module_code: str) → merchantapi.request.Module

Set Module_Code.

Parameters

module_code – str

Returns

Module

set_module_field(field: str, value) → merchantapi.request.Module

Add custom data to the request.

Parameters

• field – str

• value – mixed

Returns

{Module}

set_module_fields(module_fields) → merchantapi.request.Module

Set Module_Fields.

Parameters

module_fields – dict

Returns

Module

set_module_function(module_function: str) → merchantapi.request.Module

Set Module_Function.

Parameters

module_function – str

Returns

Module

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.NoteDelete(client: merchantapi.client.Client = None, note: merchantapi.model.Note = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.NoteDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_note_id() → int

Get Note_ID.

Returns

int

send() → merchantapi.response.NoteDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_note_id(note_id: int) → merchantapi.request.NoteDelete

Set Note_ID.

Parameters

note_id – int

Returns

NoteDelete

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.NoteInsert(client: merchantapi.client.Client = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.NoteInsert

Create a response object from the response data

Parameters

data –

Returns

Response

get_account_id() → int

Get Account_ID.

Returns

int

get_customer_id() → int

Get Customer_ID.

Returns

int

get_function()

Get the function of the request.

Returns

str

get_note_text() → str

Get NoteText.

Returns

str

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.NoteInsert

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_account_id(account_id: int) → merchantapi.request.NoteInsert

Set Account_ID.

Parameters

account_id – int

Returns

NoteInsert

set_customer_id(customer_id: int) → merchantapi.request.NoteInsert

Set Customer_ID.

Parameters

customer_id – int

Returns

NoteInsert

set_note_text(note_text: str) → merchantapi.request.NoteInsert

Set NoteText.

Parameters

note_text – str

Returns

NoteInsert

set_order_id(order_id: int) → merchantapi.request.NoteInsert

Set Order_ID.

Parameters

order_id – int

Returns

NoteInsert

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.NoteListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

available_search_fields = ['id', 'notetext', 'dtstamp', 'cust_id', 'account_id', 'order_id', 'admin_user', 'cust_login', 'business_title']

available_sort_fields = ['id', 'notetext', 'dtstamp', 'cust_id', 'account_id', 'order_id', 'admin_user', 'cust_login', 'business_title']

create_response(data) → merchantapi.request.NoteListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.NoteListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.NoteUpdate(client: merchantapi.client.Client = None, note: merchantapi.model.Note = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.NoteUpdate

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_note_id() → int

Get Note_ID.

Returns

int

get_note_text() → str

Get NoteText.

Returns

str

send() → merchantapi.response.NoteUpdate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_note_id(note_id: int) → merchantapi.request.NoteUpdate

Set Note_ID.

Parameters

note_id – int

Returns

NoteUpdate

set_note_text(note_text: str) → merchantapi.request.NoteUpdate

Set NoteText.

Parameters

note_text – str

Returns

NoteUpdate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderAuthorize(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderAuthorize

Create a response object from the response data

Parameters

data –

Returns

Response

get_amount() → float

Get Amount.

Returns

float

get_function()

Get the function of the request.

Returns

str

get_module_data() → str

Get Module_Data.

Returns

str

get_module_fields()

Get Module_Fields.

Returns

dict

get_module_id() → int

Get Module_ID.

Returns

int

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.OrderAuthorize

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_amount(amount: float) → merchantapi.request.OrderAuthorize

Set Amount.

Parameters

amount – float

Returns

OrderAuthorize

set_module_data(module_data: str) → merchantapi.request.OrderAuthorize

Set Module_Data.

Parameters

module_data – str

Returns

OrderAuthorize

set_module_field(field: str, value) → merchantapi.request.OrderAuthorize

Add custom data to the request.

Parameters

• field – str

• value – mixed

Returns

{OrderAuthorize}

set_module_fields(module_fields) → merchantapi.request.OrderAuthorize

Set Module_Fields.

Parameters

module_fields – dict

Returns

OrderAuthorize

set_module_id(module_id: int) → merchantapi.request.OrderAuthorize

Set Module_ID.

Parameters

module_id – int

Returns

OrderAuthorize

set_order_id(order_id: int) → merchantapi.request.OrderAuthorize

Set Order_ID.

Parameters

order_id – int

Returns

OrderAuthorize

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderCreate(client: merchantapi.client.Client = None, customer: merchantapi.model.Customer = None)

Bases: merchantapi.abstract.Request

add_charge(charge) → merchantapi.request.OrderCreate

Add Charges.

Parameters

charge – OrderCharge

Raises

Exception –

Returns

{OrderCreate}

add_charges(charges: list) → merchantapi.request.OrderCreate

Add many OrderCharge.

Parameters

charges – List of OrderCharge

Raises

Exception –

Returns

OrderCreate

add_item(item) → merchantapi.request.OrderCreate

Add Items.

Parameters

item – OrderItem

Raises

Exception –

Returns

{OrderCreate}

add_items(items: list) → merchantapi.request.OrderCreate

Add many OrderItem.

Parameters

items – List of OrderItem

Raises

Exception –

Returns

OrderCreate

add_product(product) → merchantapi.request.OrderCreate

Add Products.

Parameters

product – OrderProduct

Raises

Exception –

Returns

{OrderCreate}

add_products(products: list) → merchantapi.request.OrderCreate

Add many OrderProduct.

Parameters

products – List of OrderProduct

Raises

Exception –

Returns

OrderCreate

create_response(data) → merchantapi.request.OrderCreate

Create a response object from the response data

Parameters

data –

Returns

Response

get_bill_address1() → str

Get BillAddress1.

Returns

str

get_bill_address2() → str

Get BillAddress2.

Returns

str

get_bill_city() → str

Get BillCity.

Returns

str

get_bill_company() → str

Get BillCompany.

Returns

str

get_bill_country() → str

Get BillCountry.

Returns

str

get_bill_email() → str

Get BillEmail.

Returns

str

get_bill_fax() → str

Get BillFax.

Returns

str

get_bill_first_name() → str

Get BillFirstName.

Returns

str

get_bill_last_name() → str

Get BillLastName.

Returns

str

get_bill_phone() → str

Get BillPhone.

Returns

str

get_bill_state() → str

Get BillState.

Returns

str

get_bill_zip() → str

Get BillZip.

Returns

str

get_calculate_charges() → bool

Get CalculateCharges.

Returns

bool

get_charges() → list

Get Charges.

Returns

List of OrderCharge

get_custom_field_values() → merchantapi.model.CustomFieldValues

Get CustomField_Values.

Returns

CustomFieldValues}|None

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_items() → list

Get Items.

Returns

List of OrderItem

get_products() → list

Get Products.

Returns

List of OrderProduct

get_ship_address1() → str

Get ShipAddress1.

Returns

str

get_ship_address2() → str

Get ShipAddress2.

Returns

str

get_ship_city() → str

Get ShipCity.

Returns

str

get_ship_company() → str

Get ShipCompany.

Returns

str

get_ship_country() → str

Get ShipCountry.

Returns

str

get_ship_email() → str

Get ShipEmail.

Returns

str

get_ship_fax() → str

Get ShipFax.

Returns

str

get_ship_first_name() → str

Get ShipFirstName.

Returns

str

get_ship_last_name() → str

Get ShipLastName.

Returns

str

get_ship_phone() → str

Get ShipPhone.

Returns

str

get_ship_residential() → bool

Get ShipResidential.

Returns

bool

get_ship_state() → str

Get ShipState.

Returns

str

get_ship_zip() → str

Get ShipZip.

Returns

str

get_shipping_module_code() → str

Get Shipping_Module_Code.

Returns

str

get_shipping_module_data() → str

Get Shipping_Module_Data.

Returns

str

get_trigger_fulfillment_modules() → bool

Get TriggerFulfillmentModules.

Returns

bool

send() → merchantapi.response.OrderCreate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_bill_address1(bill_address1: str) → merchantapi.request.OrderCreate

Set BillAddress1.

Parameters

bill_address1 – str

Returns

OrderCreate

set_bill_address2(bill_address2: str) → merchantapi.request.OrderCreate

Set BillAddress2.

Parameters

bill_address2 – str

Returns

OrderCreate

set_bill_city(bill_city: str) → merchantapi.request.OrderCreate

Set BillCity.

Parameters

bill_city – str

Returns

OrderCreate

set_bill_company(bill_company: str) → merchantapi.request.OrderCreate

Set BillCompany.

Parameters

bill_company – str

Returns

OrderCreate

set_bill_country(bill_country: str) → merchantapi.request.OrderCreate

Set BillCountry.

Parameters

bill_country – str

Returns

OrderCreate

set_bill_email(bill_email: str) → merchantapi.request.OrderCreate

Set BillEmail.

Parameters

bill_email – str

Returns

OrderCreate

set_bill_fax(bill_fax: str) → merchantapi.request.OrderCreate

Set BillFax.

Parameters

bill_fax – str

Returns

OrderCreate

set_bill_first_name(bill_first_name: str) → merchantapi.request.OrderCreate

Set BillFirstName.

Parameters

bill_first_name – str

Returns

OrderCreate

set_bill_last_name(bill_last_name: str) → merchantapi.request.OrderCreate

Set BillLastName.

Parameters

bill_last_name – str

Returns

OrderCreate

set_bill_phone(bill_phone: str) → merchantapi.request.OrderCreate

Set BillPhone.

Parameters

bill_phone – str

Returns

OrderCreate

set_bill_state(bill_state: str) → merchantapi.request.OrderCreate

Set BillState.

Parameters

bill_state – str

Returns

OrderCreate

set_bill_zip(bill_zip: str) → merchantapi.request.OrderCreate

Set BillZip.

Parameters

bill_zip – str

Returns

OrderCreate

set_calculate_charges(calculate_charges: bool) → merchantapi.request.OrderCreate

Set CalculateCharges.

Parameters

calculate_charges – bool

Returns

OrderCreate

set_charges(charges: list) → merchantapi.request.OrderCreate

Set Charges.

Parameters

charges – {OrderCharge[]}

Raises

Exception –

Returns

OrderCreate

set_custom_field_values(custom_field_values: merchantapi.model.CustomFieldValues) → merchantapi.request.OrderCreate

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues}|None

Raises

Exception –

Returns

OrderCreate

set_customer_id(customer_id: int) → merchantapi.request.OrderCreate

Set Customer_ID.

Parameters

customer_id – int

Returns

OrderCreate

set_customer_login(customer_login: str) → merchantapi.request.OrderCreate

Set Customer_Login.

Parameters

customer_login – str

Returns

OrderCreate

set_items(items: list) → merchantapi.request.OrderCreate

Set Items.

Parameters

items – {OrderItem[]}

Raises

Exception –

Returns

OrderCreate

set_products(products: list) → merchantapi.request.OrderCreate

Set Products.

Parameters

products – {OrderProduct[]}

Raises

Exception –

Returns

OrderCreate

set_ship_address1(ship_address1: str) → merchantapi.request.OrderCreate

Set ShipAddress1.

Parameters

ship_address1 – str

Returns

OrderCreate

set_ship_address2(ship_address2: str) → merchantapi.request.OrderCreate

Set ShipAddress2.

Parameters

ship_address2 – str

Returns

OrderCreate

set_ship_city(ship_city: str) → merchantapi.request.OrderCreate

Set ShipCity.

Parameters

ship_city – str

Returns

OrderCreate

set_ship_company(ship_company: str) → merchantapi.request.OrderCreate

Set ShipCompany.

Parameters

ship_company – str

Returns

OrderCreate

set_ship_country(ship_country: str) → merchantapi.request.OrderCreate

Set ShipCountry.

Parameters

ship_country – str

Returns

OrderCreate

set_ship_email(ship_email: str) → merchantapi.request.OrderCreate

Set ShipEmail.

Parameters

ship_email – str

Returns

OrderCreate

set_ship_fax(ship_fax: str) → merchantapi.request.OrderCreate

Set ShipFax.

Parameters

ship_fax – str

Returns

OrderCreate

set_ship_first_name(ship_first_name: str) → merchantapi.request.OrderCreate

Set ShipFirstName.

Parameters

ship_first_name – str

Returns

OrderCreate

set_ship_last_name(ship_last_name: str) → merchantapi.request.OrderCreate

Set ShipLastName.

Parameters

ship_last_name – str

Returns

OrderCreate

set_ship_phone(ship_phone: str) → merchantapi.request.OrderCreate

Set ShipPhone.

Parameters

ship_phone – str

Returns

OrderCreate

set_ship_residential(ship_residential: bool) → merchantapi.request.OrderCreate

Set ShipResidential.

Parameters

ship_residential – bool

Returns

OrderCreate

set_ship_state(ship_state: str) → merchantapi.request.OrderCreate

Set ShipState.

Parameters

ship_state – str

Returns

OrderCreate

set_ship_zip(ship_zip: str) → merchantapi.request.OrderCreate

Set ShipZip.

Parameters

ship_zip – str

Returns

OrderCreate

set_shipping_module_code(shipping_module_code: str) → merchantapi.request.OrderCreate

Set Shipping_Module_Code.

Parameters

shipping_module_code – str

Returns

OrderCreate

set_shipping_module_data(shipping_module_data: str) → merchantapi.request.OrderCreate

Set Shipping_Module_Data.

Parameters

shipping_module_data – str

Returns

OrderCreate

set_trigger_fulfillment_modules(trigger_fulfillment_modules: bool) → merchantapi.request.OrderCreate

Set TriggerFulfillmentModules.

Parameters

trigger_fulfillment_modules – bool

Returns

OrderCreate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderCreateFromOrder(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderCreateFromOrder

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.OrderCreateFromOrder

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_order_id(order_id: int) → merchantapi.request.OrderCreateFromOrder

Set Order_ID.

Parameters

order_id – int

Returns

OrderCreateFromOrder

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderCustomFieldListLoad(client: merchantapi.client.Client = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderCustomFieldListLoad

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.OrderCustomFieldListLoad

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.OrderCustomFieldsUpdate(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderCustomFieldsUpdate

Create a response object from the response data

Parameters

data –

Returns

Response

get_custom_field_values() → merchantapi.model.CustomFieldValues

Get CustomField_Values.

Returns

CustomFieldValues}|None

get_function()

Get the function of the request.

Returns

str

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.OrderCustomFieldsUpdate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_custom_field_values(custom_field_values: merchantapi.model.CustomFieldValues) → merchantapi.request.OrderCustomFieldsUpdate

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues}|None

Raises

Exception –

Returns

OrderCustomFieldsUpdate

set_order_id(order_id: int) → merchantapi.request.OrderCustomFieldsUpdate

Set Order_ID.

Parameters

order_id – int

Returns

OrderCustomFieldsUpdate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderDelete(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.OrderDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_order_id(order_id: int) → merchantapi.request.OrderDelete

Set Order_ID.

Parameters

order_id – int

Returns

OrderDelete

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderItemAdd(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

add_option(option) → merchantapi.request.OrderItemAdd

Add Options.

Parameters

option – OrderItemOption

Raises

Exception –

Returns

{OrderItemAdd}

add_options(options: list) → merchantapi.request.OrderItemAdd

Add many OrderItemOption.

Parameters

options – List of OrderItemOption

Raises

Exception –

Returns

OrderItemAdd

create_response(data) → merchantapi.request.OrderItemAdd

Create a response object from the response data

Parameters

data –

Returns

Response

get_code() → str

Get Code.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_name() → str

Get Name.

Returns

str

get_options() → list

Get Options.

Returns

List of OrderItemOption

get_order_id() → int

Get Order_ID.

Returns

int

get_price() → float

Get Price.

Returns

float

get_quantity() → int

Get Quantity.

Returns

int

get_sku() → str

Get Sku.

Returns

str

get_taxable() → bool

Get Taxable.

Returns

bool

get_weight() → float

Get Weight.

Returns

float

send() → merchantapi.response.OrderItemAdd

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_code(code: str) → merchantapi.request.OrderItemAdd

Set Code.

Parameters

code – str

Returns

OrderItemAdd

set_name(name: str) → merchantapi.request.OrderItemAdd

Set Name.

Parameters

name – str

Returns

OrderItemAdd

set_options(options: list) → merchantapi.request.OrderItemAdd

Set Options.

Parameters

options – {OrderItemOption[]}

Raises

Exception –

Returns

OrderItemAdd

set_order_id(order_id: int) → merchantapi.request.OrderItemAdd

Set Order_ID.

Parameters

order_id – int

Returns

OrderItemAdd

set_price(price: float) → merchantapi.request.OrderItemAdd

Set Price.

Parameters

price – float

Returns

OrderItemAdd

set_quantity(quantity: int) → merchantapi.request.OrderItemAdd

Set Quantity.

Parameters

quantity – int

Returns

OrderItemAdd

set_sku(sku: str) → merchantapi.request.OrderItemAdd

Set Sku.

Parameters

sku – str

Returns

OrderItemAdd

set_taxable(taxable: bool) → merchantapi.request.OrderItemAdd

Set Taxable.

Parameters

taxable – bool

Returns

OrderItemAdd

set_weight(weight: float) → merchantapi.request.OrderItemAdd

Set Weight.

Parameters

weight – float

Returns

OrderItemAdd

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderItemListBackOrder(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

add_line_id(line_id) → merchantapi.request.OrderItemListBackOrder

Add Line_IDs.

Parameters

line_id – int

Returns

{OrderItemListBackOrder}

add_order_item(order_item: merchantapi.model.OrderItem) → merchantapi.request.OrderItemListBackOrder

Add OrderItem model.

Parameters

order_item – OrderItem

Raises

Exception –

Returns

OrderItemListBackOrder

create_response(data) → merchantapi.request.OrderItemListBackOrder

Create a response object from the response data

Parameters

data –

Returns

Response

get_date_in_stock() → int

Get Date_InStock.

Returns

int

get_function()

Get the function of the request.

Returns

str

get_line_ids()

Get Line_IDs.

Returns

list

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.OrderItemListBackOrder

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_date_in_stock(date_in_stock: int) → merchantapi.request.OrderItemListBackOrder

Set Date_InStock.

Parameters

date_in_stock – int

Returns

OrderItemListBackOrder

set_order_id(order_id: int) → merchantapi.request.OrderItemListBackOrder

Set Order_ID.

Parameters

order_id – int

Returns

OrderItemListBackOrder

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderItemListCancel(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

add_line_id(line_id) → merchantapi.request.OrderItemListCancel

Add Line_IDs.

Parameters

line_id – int

Returns

{OrderItemListCancel}

add_order_item(order_item: merchantapi.model.OrderItem) → merchantapi.request.OrderItemListCancel

Add OrderItem model.

Parameters

order_item – OrderItem

Raises

Exception –

Returns

OrderItemListCancel

create_response(data) → merchantapi.request.OrderItemListCancel

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_line_ids()

Get Line_IDs.

Returns

list

get_order_id() → int

Get Order_ID.

Returns

int

get_reason() → str

Get Reason.

Returns

str

send() → merchantapi.response.OrderItemListCancel

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_order_id(order_id: int) → merchantapi.request.OrderItemListCancel

Set Order_ID.

Parameters

order_id – int

Returns

OrderItemListCancel

set_reason(reason: str) → merchantapi.request.OrderItemListCancel

Set Reason.

Parameters

reason – str

Returns

OrderItemListCancel

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderItemListCreateShipment(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

add_line_id(line_id) → merchantapi.request.OrderItemListCreateShipment

Add Line_IDs.

Parameters

line_id – int

Returns

{OrderItemListCreateShipment}

add_order_item(order_item: merchantapi.model.OrderItem) → merchantapi.request.OrderItemListCreateShipment

Add OrderItem model.

Parameters

order_item – OrderItem

Raises

Exception –

Returns

OrderItemListCreateShipment

create_response(data) → merchantapi.request.OrderItemListCreateShipment

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_line_ids()

Get Line_IDs.

Returns

list

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.OrderItemListCreateShipment

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_order_id(order_id: int) → merchantapi.request.OrderItemListCreateShipment

Set Order_ID.

Parameters

order_id – int

Returns

OrderItemListCreateShipment

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderItemListDelete(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

add_line_id(line_id) → merchantapi.request.OrderItemListDelete

Add Line_IDs.

Parameters

line_id – int

Returns

{OrderItemListDelete}

add_order_item(order_item: merchantapi.model.OrderItem) → merchantapi.request.OrderItemListDelete

Add OrderItem model.

Parameters

order_item – OrderItem

Raises

Exception –

Returns

OrderItemListDelete

create_response(data) → merchantapi.request.OrderItemListDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_line_ids()

Get Line_IDs.

Returns

list

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.OrderItemListDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_order_id(order_id: int) → merchantapi.request.OrderItemListDelete

Set Order_ID.

Parameters

order_id – int

Returns

OrderItemListDelete

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderItemUpdate(client: merchantapi.client.Client = None, order_item: merchantapi.model.OrderItem = None)

Bases: merchantapi.abstract.Request

add_option(option) → merchantapi.request.OrderItemUpdate

Add Options.

Parameters

option – OrderItemOption

Raises

Exception –

Returns

{OrderItemUpdate}

add_options(options: list) → merchantapi.request.OrderItemUpdate

Add many OrderItemOption.

Parameters

options – List of OrderItemOption

Raises

Exception –

Returns

OrderItemUpdate

create_response(data) → merchantapi.request.OrderItemUpdate

Create a response object from the response data

Parameters

data –

Returns

Response

get_code() → str

Get Code.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_line_id() → int

Get Line_ID.

Returns

int

get_name() → str

Get Name.

Returns

str

get_options() → list

Get Options.

Returns

List of OrderItemOption

get_order_id() → int

Get Order_ID.

Returns

int

get_price() → float

Get Price.

Returns

float

get_quantity() → int

Get Quantity.

Returns

int

get_sku() → str

Get Sku.

Returns

str

get_taxable() → bool

Get Taxable.

Returns

bool

get_weight() → float

Get Weight.

Returns

float

send() → merchantapi.response.OrderItemUpdate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_code(code: str) → merchantapi.request.OrderItemUpdate

Set Code.

Parameters

code – str

Returns

OrderItemUpdate

set_line_id(line_id: int) → merchantapi.request.OrderItemUpdate

Set Line_ID.

Parameters

line_id – int

Returns

OrderItemUpdate

set_name(name: str) → merchantapi.request.OrderItemUpdate

Set Name.

Parameters

name – str

Returns

OrderItemUpdate

set_options(options: list) → merchantapi.request.OrderItemUpdate

Set Options.

Parameters

options – {OrderItemOption[]}

Raises

Exception –

Returns

OrderItemUpdate

set_order_id(order_id: int) → merchantapi.request.OrderItemUpdate

Set Order_ID.

Parameters

order_id – int

Returns

OrderItemUpdate

set_price(price: float) → merchantapi.request.OrderItemUpdate

Set Price.

Parameters

price – float

Returns

OrderItemUpdate

set_quantity(quantity: int) → merchantapi.request.OrderItemUpdate

Set Quantity.

Parameters

quantity – int

Returns

OrderItemUpdate

set_sku(sku: str) → merchantapi.request.OrderItemUpdate

Set Sku.

Parameters

sku – str

Returns

OrderItemUpdate

set_taxable(taxable: bool) → merchantapi.request.OrderItemUpdate

Set Taxable.

Parameters

taxable – bool

Returns

OrderItemUpdate

set_weight(weight: float) → merchantapi.request.OrderItemUpdate

Set Weight.

Parameters

weight – float

Returns

OrderItemUpdate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

PAY_STATUS_FILTER_AUTH_ONLY = 'auth_0_capt'

PAY_STATUS_FILTER_CAPTURED_NOT_SHIPPED = 'capt_not_ship'

PAY_STATUS_FILTER_PARTIAL_CAPTURE = 'partial_capt'

PAY_STATUS_FILTER_SHIPPED_NOT_CAPTURED = 'ship_not_capt'

available_custom_filters = {'BusinessAccount_ID': 'int', 'Customer_ID': 'int', 'pay_id': 'int', 'payment': ['auth_0_capt', 'partial_capt', 'capt_not_ship', 'ship_not_capt'], 'product_code': 'str'}

available_on_demand_columns = ['ship_method', 'cust_login', 'cust_pw_email', 'business_title', 'payment_module', 'customer', 'items', 'charges', 'coupons', 'discounts', 'payments', 'notes']

available_search_fields = ['id', 'batch_id', 'status', 'pay_status', 'orderdate', 'dt_instock', 'ship_res', 'ship_fname', 'ship_lname', 'ship_email', 'ship_comp', 'ship_phone', 'ship_fax', 'ship_addr1', 'ship_addr2', 'ship_city', 'ship_state', 'ship_zip', 'ship_cntry', 'bill_fname', 'bill_lname', 'bill_email', 'bill_comp', 'bill_phone', 'bill_fax', 'bill_addr1', 'bill_addr2', 'bill_city', 'bill_state', 'bill_zip', 'bill_cntry', 'ship_id', 'ship_data', 'source', 'source_id', 'total', 'total_ship', 'total_tax', 'total_auth', 'total_capt', 'total_rfnd', 'net_capt', 'pend_count', 'bord_count', 'cust_login', 'cust_pw_email', 'business_title', 'note_count']

available_sort_fields = ['id', 'batch_id', 'status', 'pay_status', 'orderdate', 'dt_instock', 'ship_res', 'ship_fname', 'ship_lname', 'ship_email', 'ship_comp', 'ship_phone', 'ship_fax', 'ship_addr1', 'ship_addr2', 'ship_city', 'ship_state', 'ship_zip', 'ship_cntry', 'bill_fname', 'bill_lname', 'bill_email', 'bill_comp', 'bill_phone', 'bill_fax', 'bill_addr1', 'bill_addr2', 'bill_city', 'bill_state', 'bill_zip', 'bill_cntry', 'ship_data', 'source', 'source_id', 'total', 'total_ship', 'total_tax', 'total_auth', 'total_capt', 'total_rfnd', 'net_capt', 'pend_count', 'bord_count', 'cust_login', 'cust_pw_email', 'business_title', 'note_count', 'payment_module']

create_response(data) → merchantapi.request.OrderListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_passphrase() → str

Get Passphrase.

Returns

str

send() → merchantapi.response.OrderListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_passphrase(passphrase: str) → merchantapi.request.OrderListLoadQuery

Set Passphrase.

Parameters

passphrase – str

Returns

OrderListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderPaymentCapture(client: merchantapi.client.Client = None, order_payment: merchantapi.model.OrderPayment = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderPaymentCapture

Create a response object from the response data

Parameters

data –

Returns

Response

get_amount() → float

Get Amount.

Returns

float

get_function()

Get the function of the request.

Returns

str

get_order_payment_id() → int

Get OrderPayment_ID.

Returns

int

send() → merchantapi.response.OrderPaymentCapture

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_amount(amount: float) → merchantapi.request.OrderPaymentCapture

Set Amount.

Parameters

amount – float

Returns

OrderPaymentCapture

set_order_payment_id(order_payment_id: int) → merchantapi.request.OrderPaymentCapture

Set OrderPayment_ID.

Parameters

order_payment_id – int

Returns

OrderPaymentCapture

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderPaymentRefund(client: merchantapi.client.Client = None, order_payment: merchantapi.model.OrderPayment = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderPaymentRefund

Create a response object from the response data

Parameters

data –

Returns

Response

get_amount() → float

Get Amount.

Returns

float

get_function()

Get the function of the request.

Returns

str

get_order_payment_id() → int

Get OrderPayment_ID.

Returns

int

send() → merchantapi.response.OrderPaymentRefund

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_amount(amount: float) → merchantapi.request.OrderPaymentRefund

Set Amount.

Parameters

amount – float

Returns

OrderPaymentRefund

set_order_payment_id(order_payment_id: int) → merchantapi.request.OrderPaymentRefund

Set OrderPayment_ID.

Parameters

order_payment_id – int

Returns

OrderPaymentRefund

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderPaymentVoid(client: merchantapi.client.Client = None, order_payment: merchantapi.model.OrderPayment = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderPaymentVoid

Create a response object from the response data

Parameters

data –

Returns

Response

get_amount() → float

Get Amount.

Returns

float

get_function()

Get the function of the request.

Returns

str

get_order_payment_id() → int

Get OrderPayment_ID.

Returns

int

send() → merchantapi.response.OrderPaymentVoid

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_amount(amount: float) → merchantapi.request.OrderPaymentVoid

Set Amount.

Parameters

amount – float

Returns

OrderPaymentVoid

set_order_payment_id(order_payment_id: int) → merchantapi.request.OrderPaymentVoid

Set OrderPayment_ID.

Parameters

order_payment_id – int

Returns

OrderPaymentVoid

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderShipmentListUpdate(client: merchantapi.client.Client = None)

Bases: merchantapi.abstract.Request

add_shipment_update(shipment_update) → merchantapi.request.OrderShipmentListUpdate

Add Shipment_Updates.

Parameters

shipment_update – OrderShipmentUpdate

Raises

Exception –

Returns

{OrderShipmentListUpdate}

add_shipment_updates(shipment_updates: list) → merchantapi.request.OrderShipmentListUpdate

Add many OrderShipmentUpdate.

Parameters

shipment_updates – List of OrderShipmentUpdate

Raises

Exception –

Returns

OrderShipmentListUpdate

create_response(data) → merchantapi.request.OrderShipmentListUpdate

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_shipment_updates() → list

Get Shipment_Updates.

Returns

List of OrderShipmentUpdate

send() → merchantapi.response.OrderShipmentListUpdate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_shipment_updates(shipment_updates: list) → merchantapi.request.OrderShipmentListUpdate

Set Shipment_Updates.

Parameters

shipment_updates – {OrderShipmentUpdate[]}

Raises

Exception –

Returns

OrderShipmentListUpdate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.OrderUpdateCustomerInformation(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.OrderUpdateCustomerInformation

Create a response object from the response data

Parameters

data –

Returns

Response

get_bill_address1() → str

Get Bill_Address1.

Returns

str

get_bill_address2() → str

Get Bill_Address2.

Returns

str

get_bill_city() → str

Get Bill_City.

Returns

str

get_bill_company() → str

Get Bill_Company.

Returns

str

get_bill_country() → str

Get Bill_Country.

Returns

str

get_bill_email() → str

Get Bill_Email.

Returns

str

get_bill_fax() → str

Get Bill_Fax.

Returns

str

get_bill_first_name() → str

Get Bill_FirstName.

Returns

str

get_bill_last_name() → str

Get Bill_LastName.

Returns

str

get_bill_phone() → str

Get Bill_Phone.

Returns

str

get_bill_state() → str

Get Bill_State.

Returns

str

get_bill_zip() → str

Get Bill_Zip.

Returns

str

get_customer_id() → int

Get Customer_ID.

Returns

int

get_function()

Get the function of the request.

Returns

str

get_order_id() → int

Get Order_ID.

Returns

int

get_ship_address1() → str

Get Ship_Address1.

Returns

str

get_ship_address2() → str

Get Ship_Address2.

Returns

str

get_ship_city() → str

Get Ship_City.

Returns

str

get_ship_company() → str

Get Ship_Company.

Returns

str

get_ship_country() → str

Get Ship_Country.

Returns

str

get_ship_email() → str

Get Ship_Email.

Returns

str

get_ship_fax() → str

Get Ship_Fax.

Returns

str

get_ship_first_name() → str

Get Ship_FirstName.

Returns

str

get_ship_last_name() → str

Get Ship_LastName.

Returns

str

get_ship_phone() → str

Get Ship_Phone.

Returns

str

get_ship_residential() → bool

Get Ship_Residential.

Returns

bool

get_ship_state() → str

Get Ship_State.

Returns

str

get_ship_zip() → str

Get Ship_Zip.

Returns

str

send() → merchantapi.response.OrderUpdateCustomerInformation

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_bill_address1(bill_address1: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_Address1.

Parameters

bill_address1 – str

Returns

OrderUpdateCustomerInformation

set_bill_address2(bill_address2: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_Address2.

Parameters

bill_address2 – str

Returns

OrderUpdateCustomerInformation

set_bill_city(bill_city: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_City.

Parameters

bill_city – str

Returns

OrderUpdateCustomerInformation

set_bill_company(bill_company: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_Company.

Parameters

bill_company – str

Returns

OrderUpdateCustomerInformation

set_bill_country(bill_country: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_Country.

Parameters

bill_country – str

Returns

OrderUpdateCustomerInformation

set_bill_email(bill_email: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_Email.

Parameters

bill_email – str

Returns

OrderUpdateCustomerInformation

set_bill_fax(bill_fax: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_Fax.

Parameters

bill_fax – str

Returns

OrderUpdateCustomerInformation

set_bill_first_name(bill_first_name: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_FirstName.

Parameters

bill_first_name – str

Returns

OrderUpdateCustomerInformation

set_bill_last_name(bill_last_name: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_LastName.

Parameters

bill_last_name – str

Returns

OrderUpdateCustomerInformation

set_bill_phone(bill_phone: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_Phone.

Parameters

bill_phone – str

Returns

OrderUpdateCustomerInformation

set_bill_state(bill_state: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_State.

Parameters

bill_state – str

Returns

OrderUpdateCustomerInformation

set_bill_zip(bill_zip: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Bill_Zip.

Parameters

bill_zip – str

Returns

OrderUpdateCustomerInformation

set_customer_id(customer_id: int) → merchantapi.request.OrderUpdateCustomerInformation

Set Customer_ID.

Parameters

customer_id – int

Returns

OrderUpdateCustomerInformation

set_order_id(order_id: int) → merchantapi.request.OrderUpdateCustomerInformation

Set Order_ID.

Parameters

order_id – int

Returns

OrderUpdateCustomerInformation

set_ship_address1(ship_address1: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Address1.

Parameters

ship_address1 – str

Returns

OrderUpdateCustomerInformation

set_ship_address2(ship_address2: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Address2.

Parameters

ship_address2 – str

Returns

OrderUpdateCustomerInformation

set_ship_city(ship_city: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_City.

Parameters

ship_city – str

Returns

OrderUpdateCustomerInformation

set_ship_company(ship_company: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Company.

Parameters

ship_company – str

Returns

OrderUpdateCustomerInformation

set_ship_country(ship_country: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Country.

Parameters

ship_country – str

Returns

OrderUpdateCustomerInformation

set_ship_email(ship_email: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Email.

Parameters

ship_email – str

Returns

OrderUpdateCustomerInformation

set_ship_fax(ship_fax: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Fax.

Parameters

ship_fax – str

Returns

OrderUpdateCustomerInformation

set_ship_first_name(ship_first_name: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_FirstName.

Parameters

ship_first_name – str

Returns

OrderUpdateCustomerInformation

set_ship_last_name(ship_last_name: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_LastName.

Parameters

ship_last_name – str

Returns

OrderUpdateCustomerInformation

set_ship_phone(ship_phone: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Phone.

Parameters

ship_phone – str

Returns

OrderUpdateCustomerInformation

set_ship_residential(ship_residential: bool) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Residential.

Parameters

ship_residential – bool

Returns

OrderUpdateCustomerInformation

set_ship_state(ship_state: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_State.

Parameters

ship_state – str

Returns

OrderUpdateCustomerInformation

set_ship_zip(ship_zip: str) → merchantapi.request.OrderUpdateCustomerInformation

Set Ship_Zip.

Parameters

ship_zip – str

Returns

OrderUpdateCustomerInformation

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PaymentMethodListLoad(client: merchantapi.client.Client = None, order: merchantapi.model.Order = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.PaymentMethodListLoad

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_order_id() → int

Get Order_ID.

Returns

int

send() → merchantapi.response.PaymentMethodListLoad

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_order_id(order_id: int) → merchantapi.request.PaymentMethodListLoad

Set Order_ID.

Parameters

order_id – int

Returns

PaymentMethodListLoad

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PriceGroupCustomerListLoadQuery(client: merchantapi.client.Client = None, price_group: merchantapi.model.PriceGroup = None)

Bases: merchantapi.request.CustomerListLoadQuery

create_response(data) → merchantapi.request.PriceGroupCustomerListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_function()

Get the function of the request.

Returns

str

get_price_group_id() → int

Get PriceGroup_ID.

Returns

int

get_price_group_name() → str

Get PriceGroup_Name.

Returns

str

get_unassigned() → bool

Get Unassigned.

Returns

bool

send() → merchantapi.response.PriceGroupCustomerListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.PriceGroupCustomerListLoadQuery

Set Assigned.

Parameters

assigned – bool

Returns

PriceGroupCustomerListLoadQuery

set_price_group_id(price_group_id: int) → merchantapi.request.PriceGroupCustomerListLoadQuery

Set PriceGroup_ID.

Parameters

price_group_id – int

Returns

PriceGroupCustomerListLoadQuery

set_price_group_name(price_group_name: str) → merchantapi.request.PriceGroupCustomerListLoadQuery

Set PriceGroup_Name.

Parameters

price_group_name – str

Returns

PriceGroupCustomerListLoadQuery

set_unassigned(unassigned: bool) → merchantapi.request.PriceGroupCustomerListLoadQuery

Set Unassigned.

Parameters

unassigned – bool

Returns

PriceGroupCustomerListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PriceGroupCustomerUpdateAssigned(client: merchantapi.client.Client = None, price_group: merchantapi.model.PriceGroup = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.PriceGroupCustomerUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_customer_id() → int

Get Customer_ID.

Returns

int

get_customer_login() → str

Get Customer_Login.

Returns

str

get_edit_customer() → str

Get Edit_Customer.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_price_group_id() → int

Get PriceGroup_ID.

Returns

int

get_price_group_name() → str

Get PriceGroup_Name.

Returns

str

send() → merchantapi.response.PriceGroupCustomerUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.PriceGroupCustomerUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

PriceGroupCustomerUpdateAssigned

set_customer_id(customer_id: int) → merchantapi.request.PriceGroupCustomerUpdateAssigned

Set Customer_ID.

Parameters

customer_id – int

Returns

PriceGroupCustomerUpdateAssigned

set_customer_login(customer_login: str) → merchantapi.request.PriceGroupCustomerUpdateAssigned

Set Customer_Login.

Parameters

customer_login – str

Returns

PriceGroupCustomerUpdateAssigned

set_edit_customer(edit_customer: str) → merchantapi.request.PriceGroupCustomerUpdateAssigned

Set Edit_Customer.

Parameters

edit_customer – str

Returns

PriceGroupCustomerUpdateAssigned

set_price_group_id(price_group_id: int) → merchantapi.request.PriceGroupCustomerUpdateAssigned

Set PriceGroup_ID.

Parameters

price_group_id – int

Returns

PriceGroupCustomerUpdateAssigned

set_price_group_name(price_group_name: str) → merchantapi.request.PriceGroupCustomerUpdateAssigned

Set PriceGroup_Name.

Parameters

price_group_name – str

Returns

PriceGroupCustomerUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PriceGroupListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

available_search_fields = ['id', 'name', 'type', 'module_id', 'custscope', 'rate', 'discount', 'markup', 'dt_start', 'dt_end', 'priority', 'exclusion', 'descrip', 'display', 'qmn_subtot', 'qmx_subtot', 'qmn_quan', 'qmx_quan', 'qmn_weight', 'qmx_weight', 'bmn_subtot', 'bmx_subtot', 'bmn_quan', 'bmx_quan', 'bmn_weight', 'bmx_weight']

available_sort_fields = ['id', 'name', 'type', 'module_id', 'custscope', 'rate', 'discount', 'markup', 'dt_start', 'dt_end', 'priority', 'exclusion', 'descrip', 'display', 'qmn_subtot', 'qmx_subtot', 'qmn_quan', 'qmx_quan', 'qmn_weight', 'qmx_weight', 'bmn_subtot', 'bmx_subtot', 'bmn_quan', 'bmx_quan', 'bmn_weight', 'bmx_weight']

create_response(data) → merchantapi.request.PriceGroupListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.PriceGroupListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.PriceGroupProductListLoadQuery(client: merchantapi.client.Client = None, price_group: merchantapi.model.PriceGroup = None)

Bases: merchantapi.request.ProductListLoadQuery

create_response(data) → merchantapi.request.PriceGroupProductListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_function()

Get the function of the request.

Returns

str

get_price_group_id() → int

Get PriceGroup_ID.

Returns

int

get_price_group_name() → str

Get PriceGroup_Name.

Returns

str

get_unassigned() → bool

Get Unassigned.

Returns

bool

send() → merchantapi.response.PriceGroupProductListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.PriceGroupProductListLoadQuery

Set Assigned.

Parameters

assigned – bool

Returns

PriceGroupProductListLoadQuery

set_price_group_id(price_group_id: int) → merchantapi.request.PriceGroupProductListLoadQuery

Set PriceGroup_ID.

Parameters

price_group_id – int

Returns

PriceGroupProductListLoadQuery

set_price_group_name(price_group_name: str) → merchantapi.request.PriceGroupProductListLoadQuery

Set PriceGroup_Name.

Parameters

price_group_name – str

Returns

PriceGroupProductListLoadQuery

set_unassigned(unassigned: bool) → merchantapi.request.PriceGroupProductListLoadQuery

Set Unassigned.

Parameters

unassigned – bool

Returns

PriceGroupProductListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PriceGroupProductUpdateAssigned(client: merchantapi.client.Client = None, price_group: merchantapi.model.PriceGroup = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.PriceGroupProductUpdateAssigned

Create a response object from the response data

Parameters

data –

Returns

Response

get_assigned() → bool

Get Assigned.

Returns

bool

get_edit_product() → str

Get Edit_Product.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_price_group_id() → int

Get PriceGroup_ID.

Returns

int

get_price_group_name() → str

Get PriceGroup_Name.

Returns

str

get_product_code() → str

Get Product_Code.

Returns

str

get_product_id() → int

Get Product_ID.

Returns

int

get_product_sku() → str

Get Product_SKU.

Returns

str

send() → merchantapi.response.PriceGroupProductUpdateAssigned

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_assigned(assigned: bool) → merchantapi.request.PriceGroupProductUpdateAssigned

Set Assigned.

Parameters

assigned – bool

Returns

PriceGroupProductUpdateAssigned

set_edit_product(edit_product: str) → merchantapi.request.PriceGroupProductUpdateAssigned

Set Edit_Product.

Parameters

edit_product – str

Returns

PriceGroupProductUpdateAssigned

set_price_group_id(price_group_id: int) → merchantapi.request.PriceGroupProductUpdateAssigned

Set PriceGroup_ID.

Parameters

price_group_id – int

Returns

PriceGroupProductUpdateAssigned

set_price_group_name(price_group_name: str) → merchantapi.request.PriceGroupProductUpdateAssigned

Set PriceGroup_Name.

Parameters

price_group_name – str

Returns

PriceGroupProductUpdateAssigned

set_product_code(product_code: str) → merchantapi.request.PriceGroupProductUpdateAssigned

Set Product_Code.

Parameters

product_code – str

Returns

PriceGroupProductUpdateAssigned

set_product_id(product_id: int) → merchantapi.request.PriceGroupProductUpdateAssigned

Set Product_ID.

Parameters

product_id – int

Returns

PriceGroupProductUpdateAssigned

set_product_sku(product_sku: str) → merchantapi.request.PriceGroupProductUpdateAssigned

Set Product_SKU.

Parameters

product_sku – str

Returns

PriceGroupProductUpdateAssigned

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PrintQueueJobDelete(client: merchantapi.client.Client = None, print_queue_job: merchantapi.model.PrintQueueJob = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.PrintQueueJobDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_print_queue_job_id() → int

Get PrintQueueJob_ID.

Returns

int

send() → merchantapi.response.PrintQueueJobDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_print_queue_job_id(print_queue_job_id: int) → merchantapi.request.PrintQueueJobDelete

Set PrintQueueJob_ID.

Parameters

print_queue_job_id – int

Returns

PrintQueueJobDelete

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PrintQueueJobInsert(client: merchantapi.client.Client = None, print_queue: merchantapi.model.PrintQueue = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.PrintQueueJobInsert

Create a response object from the response data

Parameters

data –

Returns

Response

get_edit_print_queue() → str

Get Edit_PrintQueue.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_print_queue_description() → str

Get PrintQueue_Description.

Returns

str

get_print_queue_id() → int

Get PrintQueue_ID.

Returns

int

get_print_queue_job_data() → str

Get PrintQueueJob_Data.

Returns

str

get_print_queue_job_description() → str

Get PrintQueueJob_Description.

Returns

str

get_print_queue_job_format() → str

Get PrintQueueJob_Format.

Returns

str

send() → merchantapi.response.PrintQueueJobInsert

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_edit_print_queue(edit_print_queue: str) → merchantapi.request.PrintQueueJobInsert

Set Edit_PrintQueue.

Parameters

edit_print_queue – str

Returns

PrintQueueJobInsert

set_print_queue_description(print_queue_description: str) → merchantapi.request.PrintQueueJobInsert

Set PrintQueue_Description.

Parameters

print_queue_description – str

Returns

PrintQueueJobInsert

set_print_queue_id(print_queue_id: int) → merchantapi.request.PrintQueueJobInsert

Set PrintQueue_ID.

Parameters

print_queue_id – int

Returns

PrintQueueJobInsert

set_print_queue_job_data(print_queue_job_data: str) → merchantapi.request.PrintQueueJobInsert

Set PrintQueueJob_Data.

Parameters

print_queue_job_data – str

Returns

PrintQueueJobInsert

set_print_queue_job_description(print_queue_job_description: str) → merchantapi.request.PrintQueueJobInsert

Set PrintQueueJob_Description.

Parameters

print_queue_job_description – str

Returns

PrintQueueJobInsert

set_print_queue_job_format(print_queue_job_format: str) → merchantapi.request.PrintQueueJobInsert

Set PrintQueueJob_Format.

Parameters

print_queue_job_format – str

Returns

PrintQueueJobInsert

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PrintQueueJobListLoadQuery(client: merchantapi.client.Client = None, print_queue: merchantapi.model.PrintQueue = None)

Bases: merchantapi.listquery.ListQueryRequest

available_on_demand_columns = ['job_data']

available_search_fields = ['id', 'queue_id', 'store_id', 'user_id', 'descrip', 'job_fmt', 'job_data', 'dt_created']

available_sort_fields = ['id', 'queue_id', 'store_id', 'user_id', 'descrip', 'job_fmt', 'job_data', 'dt_created']

create_response(data) → merchantapi.request.PrintQueueJobListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_edit_print_queue() → str

Get Edit_PrintQueue.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_print_queue_description() → str

Get PrintQueue_Description.

Returns

str

get_print_queue_id() → int

Get PrintQueue_ID.

Returns

int

send() → merchantapi.response.PrintQueueJobListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_edit_print_queue(edit_print_queue: str) → merchantapi.request.PrintQueueJobListLoadQuery

Set Edit_PrintQueue.

Parameters

edit_print_queue – str

Returns

PrintQueueJobListLoadQuery

set_print_queue_description(print_queue_description: str) → merchantapi.request.PrintQueueJobListLoadQuery

Set PrintQueue_Description.

Parameters

print_queue_description – str

Returns

PrintQueueJobListLoadQuery

set_print_queue_id(print_queue_id: int) → merchantapi.request.PrintQueueJobListLoadQuery

Set PrintQueue_ID.

Parameters

print_queue_id – int

Returns

PrintQueueJobListLoadQuery

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PrintQueueJobStatus(client: merchantapi.client.Client = None, print_queue_job: merchantapi.model.PrintQueueJob = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.PrintQueueJobStatus

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_print_queue_job_id() → int

Get PrintQueueJob_ID.

Returns

int

send() → merchantapi.response.PrintQueueJobStatus

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_print_queue_job_id(print_queue_job_id: int) → merchantapi.request.PrintQueueJobStatus

Set PrintQueueJob_ID.

Parameters

print_queue_job_id – int

Returns

PrintQueueJobStatus

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.PrintQueueListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

available_search_fields = ['descrip']

available_sort_fields = ['descrip']

create_response(data) → merchantapi.request.PrintQueueListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.PrintQueueListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.ProductDelete(client: merchantapi.client.Client = None, product: merchantapi.model.Product = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.ProductDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_edit_product() → str

Get Edit_Product.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_product_code() → str

Get Product_Code.

Returns

str

get_product_id() → int

Get Product_ID.

Returns

int

get_product_sku() → str

Get Product_SKU.

Returns

str

send() → merchantapi.response.ProductDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_edit_product(edit_product: str) → merchantapi.request.ProductDelete

Set Edit_Product.

Parameters

edit_product – str

Returns

ProductDelete

set_product_code(product_code: str) → merchantapi.request.ProductDelete

Set Product_Code.

Parameters

product_code – str

Returns

ProductDelete

set_product_id(product_id: int) → merchantapi.request.ProductDelete

Set Product_ID.

Parameters

product_id – int

Returns

ProductDelete

set_product_sku(product_sku: str) → merchantapi.request.ProductDelete

Set Product_SKU.

Parameters

product_sku – str

Returns

ProductDelete

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.ProductImageAdd(client: merchantapi.client.Client = None, product: merchantapi.model.Product = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.ProductImageAdd

Create a response object from the response data

Parameters

data –

Returns

Response

get_edit_product() → str

Get Edit_Product.

Returns

str

get_filepath() → str

Get Filepath.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_image_type_id() → int

Get ImageType_ID.

Returns

int

get_product_code() → str

Get Product_Code.

Returns

str

get_product_id() → int

Get Product_ID.

Returns

int

get_product_sku() → str

Get Product_SKU.

Returns

str

send() → merchantapi.response.ProductImageAdd

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_edit_product(edit_product: str) → merchantapi.request.ProductImageAdd

Set Edit_Product.

Parameters

edit_product – str

Returns

ProductImageAdd

set_filepath(filepath: str) → merchantapi.request.ProductImageAdd

Set Filepath.

Parameters

filepath – str

Returns

ProductImageAdd

set_image_type_id(image_type_id: int) → merchantapi.request.ProductImageAdd

Set ImageType_ID.

Parameters

image_type_id – int

Returns

ProductImageAdd

set_product_code(product_code: str) → merchantapi.request.ProductImageAdd

Set Product_Code.

Parameters

product_code – str

Returns

ProductImageAdd

set_product_id(product_id: int) → merchantapi.request.ProductImageAdd

Set Product_ID.

Parameters

product_id – int

Returns

ProductImageAdd

set_product_sku(product_sku: str) → merchantapi.request.ProductImageAdd

Set Product_SKU.

Parameters

product_sku – str

Returns

ProductImageAdd

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.ProductImageDelete(client: merchantapi.client.Client = None, product_image_data: merchantapi.model.ProductImageData = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.ProductImageDelete

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_product_image_id() → int

Get ProductImage_ID.

Returns

int

send() → merchantapi.response.ProductImageDelete

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_product_image_id(product_image_id: int) → merchantapi.request.ProductImageDelete

Set ProductImage_ID.

Parameters

product_image_id – int

Returns

ProductImageDelete

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.ProductInsert(client: merchantapi.client.Client = None, product: merchantapi.model.Product = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.ProductInsert

Create a response object from the response data

Parameters

data –

Returns

Response

get_custom_field_values() → merchantapi.model.CustomFieldValues

Get CustomField_Values.

Returns

CustomFieldValues}|None

get_function()

Get the function of the request.

Returns

str

get_product_active() → bool

Get Product_Active.

Returns

bool

get_product_alternate_display_page() → str

Get Product_Alternate_Display_Page.

Returns

str

get_product_canonical_category_code() → str

Get Product_Canonical_Category_Code.

Returns

str

get_product_code() → str

Get Product_Code.

Returns

str

get_product_cost() → float

Get Product_Cost.

Returns

float

get_product_description() → str

Get Product_Description.

Returns

str

get_product_image() → str

Get Product_Image.

Returns

str

get_product_inventory() → int

Get Product_Inventory.

Returns

int

get_product_name() → str

Get Product_Name.

Returns

str

get_product_page_title() → str

Get Product_Page_Title.

Returns

str

get_product_price() → float

Get Product_Price.

Returns

float

get_product_sku() → str

Get Product_SKU.

Returns

str

get_product_taxable() → bool

Get Product_Taxable.

Returns

bool

get_product_thumbnail() → str

Get Product_Thumbnail.

Returns

str

get_product_weight() → float

Get Product_Weight.

Returns

float

send() → merchantapi.response.ProductInsert

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_custom_field_values(custom_field_values: merchantapi.model.CustomFieldValues) → merchantapi.request.ProductInsert

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues}|None

Raises

Exception –

Returns

ProductInsert

set_product_active(product_active: bool) → merchantapi.request.ProductInsert

Set Product_Active.

Parameters

product_active – bool

Returns

ProductInsert

set_product_alternate_display_page(product_alternate_display_page: str) → merchantapi.request.ProductInsert

Set Product_Alternate_Display_Page.

Parameters

product_alternate_display_page – str

Returns

ProductInsert

set_product_canonical_category_code(product_canonical_category_code: str) → merchantapi.request.ProductInsert

Set Product_Canonical_Category_Code.

Parameters

product_canonical_category_code – str

Returns

ProductInsert

set_product_code(product_code: str) → merchantapi.request.ProductInsert

Set Product_Code.

Parameters

product_code – str

Returns

ProductInsert

set_product_cost(product_cost: float) → merchantapi.request.ProductInsert

Set Product_Cost.

Parameters

product_cost – float

Returns

ProductInsert

set_product_description(product_description: str) → merchantapi.request.ProductInsert

Set Product_Description.

Parameters

product_description – str

Returns

ProductInsert

set_product_image(product_image: str) → merchantapi.request.ProductInsert

Set Product_Image.

Parameters

product_image – str

Returns

ProductInsert

set_product_inventory(product_inventory: int) → merchantapi.request.ProductInsert

Set Product_Inventory.

Parameters

product_inventory – int

Returns

ProductInsert

set_product_name(product_name: str) → merchantapi.request.ProductInsert

Set Product_Name.

Parameters

product_name – str

Returns

ProductInsert

set_product_page_title(product_page_title: str) → merchantapi.request.ProductInsert

Set Product_Page_Title.

Parameters

product_page_title – str

Returns

ProductInsert

set_product_price(product_price: float) → merchantapi.request.ProductInsert

Set Product_Price.

Parameters

product_price – float

Returns

ProductInsert

set_product_sku(product_sku: str) → merchantapi.request.ProductInsert

Set Product_SKU.

Parameters

product_sku – str

Returns

ProductInsert

set_product_taxable(product_taxable: bool) → merchantapi.request.ProductInsert

Set Product_Taxable.

Parameters

product_taxable – bool

Returns

ProductInsert

set_product_thumbnail(product_thumbnail: str) → merchantapi.request.ProductInsert

Set Product_Thumbnail.

Parameters

product_thumbnail – str

Returns

ProductInsert

set_product_weight(product_weight: float) → merchantapi.request.ProductInsert

Set Product_Weight.

Parameters

product_weight – float

Returns

ProductInsert

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.ProductListAdjustInventory(client: merchantapi.client.Client = None)

Bases: merchantapi.abstract.Request

add_inventory_adjustment(inventory_adjustment) → merchantapi.request.ProductListAdjustInventory

Add Inventory_Adjustments.

Parameters

inventory_adjustment – ProductInventoryAdjustment

Raises

Exception –

Returns

{ProductListAdjustInventory}

add_inventory_adjustments(inventory_adjustments: list) → merchantapi.request.ProductListAdjustInventory

Add many ProductInventoryAdjustment.

Parameters

inventory_adjustments – List of ProductInventoryAdjustment

Raises

Exception –

Returns

ProductListAdjustInventory

create_response(data) → merchantapi.request.ProductListAdjustInventory

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_inventory_adjustments() → list

Get Inventory_Adjustments.

Returns

List of ProductInventoryAdjustment

send() → merchantapi.response.ProductListAdjustInventory

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_inventory_adjustments(inventory_adjustments: list) → merchantapi.request.ProductListAdjustInventory

Set Inventory_Adjustments.

Parameters

inventory_adjustments – {ProductInventoryAdjustment[]}

Raises

Exception –

Returns

ProductListAdjustInventory

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.ProductListLoadQuery(client: merchantapi.client.Client = None)

Bases: merchantapi.listquery.ListQueryRequest

PRODUCT_SHOW_ACTIVE = 'Active'

PRODUCT_SHOW_ALL = 'All'

PRODUCT_SHOW_UNCATEGORIZED = 'Uncategorized'

available_custom_filters = {'Product_Show': ['All', 'Uncategorized', 'Active']}

available_on_demand_columns = ['descrip', 'catcount', 'productinventorysettings', 'attributes', 'productimagedata', 'categories', 'productshippingrules', 'relatedproducts', 'uris']

available_search_fields = ['id', 'code', 'sku', 'cancat_code', 'page_code', 'name', 'thumbnail', 'image', 'price', 'cost', 'descrip', 'weight', 'taxable', 'active', 'page_title', 'dt_created', 'dt_updated', 'category', 'product_inventory']

available_sort_fields = ['id', 'code', 'sku', 'cancat_code', 'page_code', 'name', 'thumbnail', 'image', 'price', 'cost', 'descrip', 'weight', 'taxable', 'active', 'page_title', 'dt_created', 'dt_updated']

create_response(data) → merchantapi.request.ProductListLoadQuery

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

send() → merchantapi.response.ProductListLoadQuery

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

class merchantapi.request.ProductUpdate(client: merchantapi.client.Client = None, product: merchantapi.model.Product = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.ProductUpdate

Create a response object from the response data

Parameters

data –

Returns

Response

get_custom_field_values() → merchantapi.model.CustomFieldValues

Get CustomField_Values.

Returns

CustomFieldValues}|None

get_edit_product() → str

Get Edit_Product.

Returns

str

get_function()

Get the function of the request.

Returns

str

get_product_active() → bool

Get Product_Active.

Returns

bool

get_product_alternate_display_page() → str

Get Product_Alternate_Display_Page.

Returns

str

get_product_canonical_category_code() → str

Get Product_Canonical_Category_Code.

Returns

str

get_product_code() → str

Get Product_Code.

Returns

str

get_product_cost() → float

Get Product_Cost.

Returns

float

get_product_description() → str

Get Product_Description.

Returns

str

get_product_id() → int

Get Product_ID.

Returns

int

get_product_image() → str

Get Product_Image.

Returns

str

get_product_inventory() → int

Get Product_Inventory.

Returns

int

get_product_name() → str

Get Product_Name.

Returns

str

get_product_page_title() → str

Get Product_Page_Title.

Returns

str

get_product_price() → float

Get Product_Price.

Returns

float

get_product_sku() → str

Get Product_SKU.

Returns

str

get_product_taxable() → bool

Get Product_Taxable.

Returns

bool

get_product_thumbnail() → str

Get Product_Thumbnail.

Returns

str

get_product_weight() → float

Get Product_Weight.

Returns

float

send() → merchantapi.response.ProductUpdate

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_custom_field_values(custom_field_values: merchantapi.model.CustomFieldValues) → merchantapi.request.ProductUpdate

Set CustomField_Values.

Parameters

custom_field_values – CustomFieldValues}|None

Raises

Exception –

Returns

ProductUpdate

set_edit_product(edit_product: str) → merchantapi.request.ProductUpdate

Set Edit_Product.

Parameters

edit_product – str

Returns

ProductUpdate

set_product_active(product_active: bool) → merchantapi.request.ProductUpdate

Set Product_Active.

Parameters

product_active – bool

Returns

ProductUpdate

set_product_alternate_display_page(product_alternate_display_page: str) → merchantapi.request.ProductUpdate

Set Product_Alternate_Display_Page.

Parameters

product_alternate_display_page – str

Returns

ProductUpdate

set_product_canonical_category_code(product_canonical_category_code: str) → merchantapi.request.ProductUpdate

Set Product_Canonical_Category_Code.

Parameters

product_canonical_category_code – str

Returns

ProductUpdate

set_product_code(product_code: str) → merchantapi.request.ProductUpdate

Set Product_Code.

Parameters

product_code – str

Returns

ProductUpdate

set_product_cost(product_cost: float) → merchantapi.request.ProductUpdate

Set Product_Cost.

Parameters

product_cost – float

Returns

ProductUpdate

set_product_description(product_description: str) → merchantapi.request.ProductUpdate

Set Product_Description.

Parameters

product_description – str

Returns

ProductUpdate

set_product_id(product_id: int) → merchantapi.request.ProductUpdate

Set Product_ID.

Parameters

product_id – int

Returns

ProductUpdate

set_product_image(product_image: str) → merchantapi.request.ProductUpdate

Set Product_Image.

Parameters

product_image – str

Returns

ProductUpdate

set_product_inventory(product_inventory: int) → merchantapi.request.ProductUpdate

Set Product_Inventory.

Parameters

product_inventory – int

Returns

ProductUpdate

set_product_name(product_name: str) → merchantapi.request.ProductUpdate

Set Product_Name.

Parameters

product_name – str

Returns

ProductUpdate

set_product_page_title(product_page_title: str) → merchantapi.request.ProductUpdate

Set Product_Page_Title.

Parameters

product_page_title – str

Returns

ProductUpdate

set_product_price(product_price: float) → merchantapi.request.ProductUpdate

Set Product_Price.

Parameters

product_price – float

Returns

ProductUpdate

set_product_sku(product_sku: str) → merchantapi.request.ProductUpdate

Set Product_SKU.

Parameters

product_sku – str

Returns

ProductUpdate

set_product_taxable(product_taxable: bool) → merchantapi.request.ProductUpdate

Set Product_Taxable.

Parameters

product_taxable – bool

Returns

ProductUpdate

set_product_thumbnail(product_thumbnail: str) → merchantapi.request.ProductUpdate

Set Product_Thumbnail.

Parameters

product_thumbnail – str

Returns

ProductUpdate

set_product_weight(product_weight: float) → merchantapi.request.ProductUpdate

Set Product_Weight.

Parameters

product_weight – float

Returns

ProductUpdate

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.ProductVariantListLoadProduct(client: merchantapi.client.Client = None, product: merchantapi.model.Product = None)

Bases: merchantapi.abstract.Request

add_exclusion(exclusion) → merchantapi.request.ProductVariantListLoadProduct

Add Exclusions.

Parameters

exclusion – ProductVariantExclusion

Raises

Exception –

Returns

{ProductVariantListLoadProduct}

add_exclusions(exclusions: list) → merchantapi.request.ProductVariantListLoadProduct

Add many ProductVariantExclusion.

Parameters

exclusions – List of ProductVariantExclusion

Raises

Exception –

Returns

ProductVariantListLoadProduct

add_limit(limit) → merchantapi.request.ProductVariantListLoadProduct

Add Limits.

Parameters

limit – ProductVariantLimit

Raises

Exception –

Returns

{ProductVariantListLoadProduct}

add_limits(limits: list) → merchantapi.request.ProductVariantListLoadProduct

Add many ProductVariantLimit.

Parameters

limits – List of ProductVariantLimit

Raises

Exception –

Returns

ProductVariantListLoadProduct

create_response(data) → merchantapi.request.ProductVariantListLoadProduct

Create a response object from the response data

Parameters

data –

Returns

Response

get_edit_product() → str

Get Edit_Product.

Returns

str

get_exclusions() → list

Get Exclusions.

Returns

List of ProductVariantExclusion

get_function()

Get the function of the request.

Returns

str

get_include_default_variant() → bool

Get Include_Default_Variant.

Returns

bool

get_limits() → list

Get Limits.

Returns

List of ProductVariantLimit

get_product_code() → str

Get Product_Code.

Returns

str

get_product_id() → int

Get Product_ID.

Returns

int

get_product_sku() → str

Get Product_SKU.

Returns

str

send() → merchantapi.response.ProductVariantListLoadProduct

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_edit_product(edit_product: str) → merchantapi.request.ProductVariantListLoadProduct

Set Edit_Product.

Parameters

edit_product – str

Returns

ProductVariantListLoadProduct

set_exclusions(exclusions: list) → merchantapi.request.ProductVariantListLoadProduct

Set Exclusions.

Parameters

exclusions – {ProductVariantExclusion[]}

Raises

Exception –

Returns

ProductVariantListLoadProduct

set_include_default_variant(include_default_variant: bool) → merchantapi.request.ProductVariantListLoadProduct

Set Include_Default_Variant.

Parameters

include_default_variant – bool

Returns

ProductVariantListLoadProduct

set_limits(limits: list) → merchantapi.request.ProductVariantListLoadProduct

Set Limits.

Parameters

limits – {ProductVariantLimit[]}

Raises

Exception –

Returns

ProductVariantListLoadProduct

set_product_code(product_code: str) → merchantapi.request.ProductVariantListLoadProduct

Set Product_Code.

Parameters

product_code – str

Returns

ProductVariantListLoadProduct

set_product_id(product_id: int) → merchantapi.request.ProductVariantListLoadProduct

Set Product_ID.

Parameters

product_id – int

Returns

ProductVariantListLoadProduct

set_product_sku(product_sku: str) → merchantapi.request.ProductVariantListLoadProduct

Set Product_SKU.

Parameters

product_sku – str

Returns

ProductVariantListLoadProduct

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.ProvisionDomain(client: merchantapi.client.Client = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.ProvisionDomain

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_xml() → str

Get xml.

Returns

str

send() → merchantapi.response.ProvisionDomain

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_xml(xml: str) → merchantapi.request.ProvisionDomain

Set xml.

Parameters

xml – str

Returns

ProvisionDomain

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.ProvisionStore(client: merchantapi.client.Client = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.request.ProvisionStore

Create a response object from the response data

Parameters

data –

Returns

Response

get_function()

Get the function of the request.

Returns

str

get_xml() → str

Get xml.

Returns

str

send() → merchantapi.response.ProvisionStore

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set_xml(xml: str) → merchantapi.request.ProvisionStore

Set xml.

Parameters

xml – str

Returns

ProvisionStore

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

class merchantapi.request.RequestBuilder(client: merchantapi.client.Client, function: str, data: dict = None)

Bases: merchantapi.abstract.Request

create_response(data) → merchantapi.response.RequestBuilder

Create a response object from the response data

Parameters

data –

Returns

Response

get(field: str, default_value=None)

Get a field value

Parameters

• field – str

• default_value – mixed

Returns

mixed

has(field: str) → bool

Check if a field exists

Parameters

field – str

Returns

bool

remove(field: str) → merchantapi.request.RequestBuilder

Remove a field if it exists

Parameters

field – str

send() → merchantapi.response.RequestBuilder

Send this object via the assigned client.

Returns

Response

Raises

Exception – when no client assigned

set(field: str, value) → merchantapi.request.RequestBuilder

Set a field value

Parameters

• field – str

• value – mixed

set_function(function: str) → merchantapi.request.RequestBuilder

Set the request function

Parameters

function – str

set_scope(scope: int) → merchantapi.request.RequestBuilder

Set the request scope

Parameters

scope – int

to_dict() → dict

Reduce the request to a dict

Override

Returns

dict

merchantapi.response module

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

$Id: response.py 77709 2019-08-30 16:41:54Z gidriss $

class merchantapi.response.AvailabilityGroupBusinessAccountUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.AvailabilityGroupCustomerUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.AvailabilityGroupListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_availability_groups()

Get availability_groups.

Returns

list of AvailabilityGroup

class merchantapi.response.AvailabilityGroupPaymentMethodUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.AvailabilityGroupProductUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.AvailabilityGroupShippingMethodUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.CategoryDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.CategoryInsert(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.CategoryListLoadParent(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_categories()

Get categories.

Returns

list of Category

class merchantapi.response.CategoryListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_categories()

Get categories.

Returns

list of Category

class merchantapi.response.CategoryProductListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_category_products()

Get category_products.

Returns

list of CategoryProduct

class merchantapi.response.CategoryProductUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.CategoryUpdate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.CouponInsert(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_id()

Get id.

Returns

int

class merchantapi.response.CouponListDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_processed()

Get processed.

Returns

int

class merchantapi.response.CouponListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_coupons()

Get coupons.

Returns

list of Coupon

class merchantapi.response.CouponPriceGroupListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_coupon_price_groups()

Get coupon_price_groups.

Returns

list of CouponPriceGroup

class merchantapi.response.CouponPriceGroupUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.CouponUpdate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.CustomerAddressListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_customer_addresses()

Get customer_addresses.

Returns

list of CustomerAddress

class merchantapi.response.CustomerDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.CustomerInsert(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_customer() → merchantapi.model.Customer

Get customer.

Returns

Customer

class merchantapi.response.CustomerListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_customers()

Get customers.

Returns

list of Customer

class merchantapi.response.CustomerPaymentCardListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_customer_payment_cards()

Get customer_payment_cards.

Returns

list of CustomerPaymentCard

class merchantapi.response.CustomerPaymentCardRegister(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_customer_payment_card() → merchantapi.model.CustomerPaymentCard

Get customer_payment_card.

Returns

CustomerPaymentCard

class merchantapi.response.CustomerPriceGroupListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_customer_price_groups()

Get customer_price_groups.

Returns

list of CustomerPriceGroup

class merchantapi.response.CustomerUpdate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.Module(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.NoteDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.NoteInsert(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.NoteListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_notes()

Get notes.

Returns

list of Note

class merchantapi.response.NoteUpdate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.OrderAuthorize(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order_payment_authorize() → merchantapi.model.OrderPaymentAuthorize

Get order_payment_authorize.

Returns

OrderPaymentAuthorize

class merchantapi.response.OrderCreate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order() → merchantapi.model.Order

Get order.

Returns

Order

class merchantapi.response.OrderCreateFromOrder(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order() → merchantapi.model.Order

Get order.

Returns

Order

class merchantapi.response.OrderCustomFieldListLoad(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order_custom_fields()

Get order_custom_fields.

Returns

list of OrderCustomField

class merchantapi.response.OrderCustomFieldsUpdate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.OrderDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.OrderItemAdd(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order_total() → merchantapi.model.OrderTotal

Get order_total.

Returns

OrderTotal

class merchantapi.response.OrderItemListBackOrder(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.OrderItemListCancel(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.OrderItemListCreateShipment(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order_shipment() → merchantapi.model.OrderShipment

Get order_shipment.

Returns

OrderShipment

class merchantapi.response.OrderItemListDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.OrderItemUpdate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order_total() → merchantapi.model.OrderTotal

Get order_total.

Returns

OrderTotal

class merchantapi.response.OrderListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_orders()

Get orders.

Returns

list of Order

class merchantapi.response.OrderPaymentCapture(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order_payment_total() → merchantapi.model.OrderPaymentTotal

Get order_payment_total.

Returns

OrderPaymentTotal

class merchantapi.response.OrderPaymentRefund(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order_payment_total() → merchantapi.model.OrderPaymentTotal

Get order_payment_total.

Returns

OrderPaymentTotal

class merchantapi.response.OrderPaymentVoid(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_order_payment_total() → merchantapi.model.OrderPaymentTotal

Get order_payment_total.

Returns

OrderPaymentTotal

class merchantapi.response.OrderShipmentListUpdate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.OrderUpdateCustomerInformation(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.PaymentMethodListLoad(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_payment_methods()

Get payment_methods.

Returns

list of PaymentMethod

class merchantapi.response.PriceGroupCustomerListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_price_group_customers()

Get price_group_customers.

Returns

list of PriceGroupCustomer

class merchantapi.response.PriceGroupCustomerUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.PriceGroupListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_price_groups()

Get price_groups.

Returns

list of PriceGroup

class merchantapi.response.PriceGroupProductListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_price_group_products()

Get price_group_products.

Returns

list of PriceGroupProduct

class merchantapi.response.PriceGroupProductUpdateAssigned(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.PrintQueueJobDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.PrintQueueJobInsert(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_id()

Get id.

Returns

int

class merchantapi.response.PrintQueueJobListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_print_queue_jobs()

Get print_queue_jobs.

Returns

list of PrintQueueJob

class merchantapi.response.PrintQueueJobStatus(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_status()

Get status.

Returns

string

class merchantapi.response.PrintQueueListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_print_queues()

Get print_queues.

Returns

list of PrintQueue

class merchantapi.response.ProductDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.ProductImageAdd(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.ProductImageDelete(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.ProductInsert(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.ProductListAdjustInventory(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.ProductListLoadQuery(request: merchantapi.listquery.ListQueryRequest, data: dict)

Bases: merchantapi.listquery.ListQueryResponse

get_products()

Get products.

Returns

list of Product

class merchantapi.response.ProductUpdate(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

class merchantapi.response.ProductVariantListLoadProduct(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_product_variants()

Get product_variants.

Returns

list of ProductVariant

class merchantapi.response.ProvisionDomain(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_provision_messages()

Get provision_messages.

Returns

list of ProvisionMessage

class merchantapi.response.ProvisionStore(request: merchantapi.abstract.Request, data: dict)

Bases: merchantapi.abstract.Response

get_provision_messages()

Get provision_messages.

Returns

list of ProvisionMessage

class merchantapi.response.RequestBuilder(request, data: dict)

Bases: merchantapi.abstract.Response

merchantapi.version module

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with self source code.

$Id: version.py 77666 2019-08-29 19:17:24Z gidriss $

class merchantapi.version.Version

Bases: object

MAJOR = 1

MINOR = 0

PATCH = 0

STRING = '1.0.0'

Module contents

This file is part of the MerchantAPI package.

3. Miva Inc <https://www.miva.com/>

For the full copyright and license information, please view the LICENSE file that was distributed with self source code.

$Id: __init__.py 77670 2019-08-29 19:21:43Z gidriss $