Cmdlets for WooCommerce

Build 20.0.7587

PaymentGateways

Retrieve and modify payment gateways.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: Id. All other columns are processed client side.

SELECT * FROM PaymentGateways WHERE Id = 'id'

Insert

This table does not have any required attributes when performing an insert.

Columns

Name Type ReadOnly Description
Id [KEY] String True

Payment gateway ID.

Title String False

Payment gateway title on checkout.

Description String False

Payment gateway description on checkout.

Order Integer False

Payment gateway sort order.

Enabled Boolean False

Payment gateway enabled status.

MethodTitle String True

Payment gateway method title.

MethodDescription String True

Payment gateway method description.

MethodSupportsAggregate String True

Supported features for this payment gateway.

SettingsTitleId String True

A unique identifier for the setting.

SettingsTitleDefault String True

Default value for the setting.

SettingsTitleDescription String True

A human readable description for the setting used in interfaces.

SettingsTitleLabel String True

A human readable label for the setting used in interfaces.

SettingsTitlePlaceholder String True

Placeholder text to be displayed in text inputs.

SettingsTitleTip String True

Additional help text shown to the user about the setting.

SettingsTitleType String True

Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.

SettingsTitleValue String True

Setting value.

SettingsInstructionsDefault String True

Default value for the setting.

SettingsInstructionsDescription String True

A human readable description for the setting used in interfaces.

SettingsInstructionsLabel String True

A human readable label for the setting used in interfaces.

SettingsInstructionsPlaceholder String True

Placeholder text to be displayed in text inputs.

SettingsInstructionsTip String True

Additional help text shown to the user about the setting.

SettingsInstructionsType String True

Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.

SettingsInstructionsValue String True

Setting value.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587