Manage Transaction Fields - Delete Field
Delete existing fields used when recording customer transactions:
The data to be submitted to the API is composed of the following fields:
|
|
field |
|
Example |
|
Note |
|
|
|
API |
|
1.6 |
|
Required |
|
|
|
user_id |
|
john1970 |
|
Required |
|
|
|
user_api_key |
|
1959caadac9b13dcb3 |
|
Required |
|
|
|
account_id |
|
greatwidgets |
|
Required |
|
|
|
type |
|
transaction_fields |
|
Required |
|
|
|
action |
|
delete |
|
Required |
|
|
|
field_list |
|
custom_field_3|custom_field_4 |
|
Required |
|
|
|
|
|
|
|
|
|
|
|
Output Format: |
|
|
|
output |
|
JSON or XML |
|
Optional. If not provided, defaults to XML |
|
|
|
callback |
|
someFunctionName |
|
Optional: JSONP format |
|
|
|
condensed |
|
yes |
|
Optional (No white space) Applies only to JSON(P) output |
|
|
|
|
|
|
|
|
|
NOTE:
- Only users with proper permissions can access this call.
- Multiple fields can be deleted at the same time.
Example PHP Request:
If you are using PHP, the $data array would look like this:
- $data['API'] = '1.5';
- $data['user_id'] = 'john1970';
- $data['user_api_key'] = '1959caadac9b13dcb3';
- $data['account_id'] = 'greatwidgets';
- $data['type'] = 'transaction_fields';
- $data['action'] = 'delete';
- $data['field_list'] = 'custom_field_3|custom_field_4'
Success XML Response (lists ONLY the remaining custom fields added):
- <response status="success">
- <account>
- <account_id>test2009050502</account_id>
- <fields>
- <field>
- <name>custom_field_1</name>
- <label>Item SKU</label>
- <show>Y</show>
- <type>Text</type>
- </field>
- <field>
- <name>custom_field_2</name>
- <label>Tags</label>
- <show>Y</show>
- <type>List</type>
- <choices>
- <choice>Tag A</choice>
- <choice>Tag B</choice>
- <choice>Tag C</choice>
- </choice>
- </field>
- <field>
- <name>custom_field_5</name>
- <label>Kilograms</label>
- <show>Y</show>
- <type>Number</type>
- </field>
- </fields>
- </account>
- </response>
Error XML Response:
- <response status="error">
- <error>Error message</error>
- </response>
|