• Documentation >
• Apps >
• Commerce >
• TradeGecko

TradeGecko

The TradeGecko modules allow you to watch, create, update, list, and/or delete stock adjustments, addresses, products, purchase orders, variants, companies, contacts, fulfillments, orders, purchase order line items and stock adjustment line items in your TradeGecko account.

Prerequisites

• A TradeGecko account

To use TradeGecko with Ibexa Connect, it is necessary to have a TradeGecko account. If you do not have one, you can create a TradeGecko account at https://go.tradegecko.com/register.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting TradeGecko to Ibexa Connect

1. Go to Ibexa Connect and open the TradeGecko module's Create a connection dialog.

2. Enter the connection and click Continue.

3. Confirm the dialog by clicking the Authorize button.

The connection has been established.

Address

Search Addresses

Returns a list of addresses.

Limit	The maximum number of addresses Ibexa Connect should return during one scenario execution cycle.
Created since	Enter the date from which you want to list the addresses. For example, 2015-11-04T00:00:00.00Z
Created until	Enter the date until which you want to list the addresses. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the addresses updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the stock addresses updated. For example, 2015-11-04T00:00:00.00Z
Filter by Company ID	Select the Company ID to filter the results.

Company

Watch New Companies

Triggers when a new company is created.

Limit	The maximum number of companies Ibexa Connect should return during one scenario execution cycle.

Search Companies

Returns a list of companies.

Limit	The maximum number of companies Ibexa Connect should return during one scenario execution cycle.
Created Since	Enter the date from which you want to list the companies. For example, 2015-11-04T00:00:00.00Z
Created Until	Enter the date until which you want to list the companies. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the companies updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the companies updated. For example, 2015-11-04T00:00:00.00Z
Filter by Company Type	Select the type of companies you want to list: Business Supplier Consumer
Filter by Email Address	Enter the email address to filter the companies you want to list.
Filter by Assignee ID	Select the Assignee ID to filter the companies you want to list.
Filter by Status	Select the option to filter the companies based on their status: Active Disabled
Filter by Company Code	Enter the company code to filter the companies you want to list.
Filter by Default Stock Location ID	Select the Default Stock Location ID to filter the companies.

View a Company

Retrieves the details of an existing company.

Company ID	Select the Company ID whose details you want to retrieve.

Create a New Company

Creates a new company object.

Company Type	Select the type of company: Business Supplier Consumer
Name	Enter the company name.
Company Code	Enter the company code.
Tax Type ID	Select the applicable Tax Type ID for the company: Purchases Tax Sales Tax Tax Exempt
Assignee ID	Select the Assignee ID to which the company will be assigned.
Ledger Account ID	Enter the Ledger Account ID of the company.
Payment Term ID	Enter the Payment Term ID for the company.
Stock Location ID	Select the Stock Location ID for the company.
Discount Rate	Enter the discount rate for the company.
Price List ID	Enter the Price List ID of the company.
Email Address	Enter the email address of the company to contact.
Fax	Enter the Fax number of the company.
Phone Number	Enter the Phone number of the company.
Tax Number	Enter the Tax Number of the company.
Website	Enter the website of the company.
Description	Enter the details of the company.
Tags	Add the tags that help searching or filtering the company: Tag Add keywords about the company to add as a tag.

Update a Company

Updates the specified Company. Any parameters not provided will be left unchanged.

Company ID	Select the Company ID you want to update.
Company type	Select the type of company to update: Business Supplier Consumer
Name	Enter the company name.
Company Code	Enter the company code.
Tax Type ID	Select the applicable Tax Type ID for the company: Purchases Tax Sales Tax Tax Exempt
Assignee ID	Select the Assignee ID to which the company will be assigned.
Ledger Account ID	Enter the Ledger Account ID of the company.
Payment Term ID	Enter the Payment Term ID for the company.
Stock Location ID	Select the Stock Location ID for the company.
Discount Rate	Enter the discount rate for the company.
Price list ID	Enter the Price List ID of the company.
Email Address	Enter the email address of the company to contact.
Fax	Enter the Fax number of the company.
Phone Number	Enter the Phone number of the company.
Tax Number	Enter the Tax Number of the company.
Website	Enter the website of the company.
Description	Enter the details of the company.
Tags	Add the tags that help searching or filtering the company: Tag Add keywords about the company to add as a tag.

Delete a Company

Permanently deletes a Company. It cannot be undone. This company is no longer available for future sales orders.

Company ID	Select the Company ID you want to delete.

Contact

Watch New Contacts

Triggers when a new contact is created.

Limit	The maximum number of contacts Ibexa Connect should return during one scenario execution cycle.

Search Contacts

Returns a list of contacts.

Limit	The maximum number of contacts Ibexa Connect should return during one scenario execution cycle.
Created Since	Enter the date from which you want to list the contacts. For example, 2015-11-04T00:00:00.00Z
Created Until	Enter the date until which you want to list the contacts. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the contacts updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the contacts updated. For example, 2015-11-04T00:00:00.00Z
Filter by Company ID	Select the Company ID to filter the contact you want to list.
Online Ordering	Select Yes if the contact has access to online ordering: Yes No Not defined

View a Contact

Retrieves the details of an existing contact.

Contact ID	Select the Contact ID whose details you want to retrieve.

Create a New Contact

Creates a new contact for the company.

Company ID	Select the Company ID of the new contact.
First Name	Enter the first name of the contact.
Last Name	Enter the last name of the contact.
Email Address	Enter the email address of the contact.
Fax	Enter the Fax number of the contact.
Location	Enter the department name of the contact.
Mobile	Enter the mobile number of the contact.
Notes	Enter any information about the contact you want to mention.
Phone Number	Enter the phone number of the contact.
Position	Enter the title of the contact.
Online Ordering	Select Yes if the contact has access to online ordering: Yes No Not defined

Update a Contact

Updates the specified contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Contact ID	Select the Contact ID you want to update.
Company ID	Select the Company ID of the new contact.
First Name	Enter the first name of the contact.
Last Name	Enter the first name of the contact.
Email Address	Enter the email address of the contact.
Fax	Enter the Fax number of the contact.
Location	Enter the department name of the contact.
Mobile	Enter the mobile number of the contact.
Notes	Enter any information about the contact you want to mention.
Phone Number	Enter the phone number of the contact.
Position	Enter the title of the contact.
Online Ordering	Select Yes if the contact has access to online ordering: Yes No Not defined

Delete a Contact

Permanently deletes a contact. It cannot be undone. This contact is no longer available for future sales orders.

Contact ID	Select the Contact ID you want to delete.

Fulfillment

List Fulfillments

Returns a list of fulfillment.

Limit	The maximum number of fulfillments Ibexa Connect should return during one scenario execution cycle.
Status	Select the status of the fulfillment you want to list: Packed Fulfilled Void Deleted
Created Since	Enter the date from which you want to list the fulfillments. For example, 2015-11-04T00:00:00.00Z
Created Until	Enter the date until which you want to list the fulfillments. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the fulfillment updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the fulfillment updated. For example, 2015-11-04T00:00:00.00Z
Filter by Order ID	Select the Order ID of the fulfillment you want to list.
Filter by Company ID	Select the Company ID of the fulfillment you want to list.
Filter by Shipping Address ID	Select the Shipping Address ID of the fulfillment you want to list.
Filter by Billing Address ID	Select the Billing Address ID of the fulfillment you want to list.
Filter by Stock Location ID	Select the Stock Location ID of the fulfillment you want to list.

Order

Watch New Orders

Triggers when a new order is created.

Limit	The maximum number of new orders Ibexa Connect should return during one scenario execution cycle.

Search Orders

Returns a list of orders.

Limit	The maximum number of orders Ibexa Connect should return during one scenario execution cycle.
Created Since	Enter the date from which you want to list the orders. For example, 2015-11-04T00:00:00.00Z
Created Until	Enter the date until which you want to list the orders. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the orders updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the orders updated. For example, 2015-11-04T00:00:00.00Z
Filter by Company ID	Select the Company ID of the order you want to list.
Filter by Assignee	Select the Assignee ID of the order you want to list.
Filter by Billing Address ID	Select the Billing Address ID of the order you want to list.
Filter by Contact ID	Select the Contact ID of the order you want to list.
Filter by Currency ID	Select the Currency ID of the order you want to list.
Filter by Shipping Address ID	Select the Shipping Address ID of the order you want to list.
Filter by Stock Location ID	Select the Stock Location ID of the order you want to list.
Filter by User ID	Select the User ID of the order you want to list.

View an Order

Retrieves the details of an existing order.

Order ID	Select the Order ID whose details you want to retrieve.

Create a new order

Creates a new order object.

Assignee ID	Select the Assignee ID whose order you want to create.
Issued at	Enter the date on which the order is created.
Ship at	Enter the date on which the order must be shipped.
Company ID	Select the Company ID to whom the order belongs to.
Billing Address ID	Select the Billing Address ID of the order.
Contact ID	Seelct the Contact ID to whom the order belongs to. The Contact ID must belong to the Company.
Shipping Address ID	Enter the Shipping Address ID of the order.
Stock Location ID	Select the Stock Location ID of the order.
Default Price List ID	Enter the Default Price List ID of the order.
Email Address	Enter the email address of the contact to whom the order belongs to.
Notes	Enter the details of the order.
Order Number	Enter the order number.
Phone Number	Enter the phone number.
Reference Number	Enter the reference number of the order.
Source URL	Enter the website URL for the order or resource document.
Tax Treatment	Select the tax treatment type: Exclusive Inclusive
Status	Select the status of the order: Active Draft Finalized

Update an Order

Updates the specified order. Any parameters not provided will be left unchanged.

Order ID	Select the Order ID you want to update.
Assignee ID	Select the Assignee ID whose order you want to update.
Issued At	Enter the date on which the order is created.
Ship At	Enter the date on which the order must be shipped.
Billing Address ID	Select the Billing Address ID of the order.
Company ID	Select the Company ID to whom the order belongs to.
Contact ID	Select the Contact ID to whom the order belongs to. The Contact ID must belong to the Company.
Shipping Address ID	Enter the Shipping Address ID of the order.
Stock Location ID	Select the Stock Location ID of the order.
Default Price List ID	Enter the Default Price List ID of the order.
Email Address	Enter the email address of the contact to whom the order belongs to.
Notes	Enter the details of the order.
Order Number	Enter the order number.
Phone Number	Enter the phone number.
Reference Number	Enter the reference number of the order.
Source URL	Enter the website URL for the order or resource document.
Tax Treatment	Select the tax treatment type: Exclusive Inclusive
Status	Select the status of the order: Active Draft Finalized

Delete an Order

Permanently deletes an order. It cannot be undone. This order is no longer available for future sales orders.

Order ID	Select the Order ID you want to delete.

Order Line Items

Watch New Order Line Items

Triggers when a new order line item is created.

Limit	The maximum number of order line items Ibexa Connect should return during one scenario execution cycle.

Search Order Line Items

Returns a list of order line items.

Limit	The maximum number of order line items Ibexa Connect should return during one scenario execution cycle.
Created Since	Enter the date from which you want to list the order line items. For example, 2015-11-04T00:00:00.00Z
Created Until	Enter the date until which you want to list the order line items. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the order line items updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the order line items updated. For example, 2015-11-04T00:00:00.00Z
Filter by Order ID	Select the Order ID to filter the order line items you want to list.
Filter by Variant ID	Select the Variant ID to filter the oder line items you want to list.
Filter by Tax Type ID	Select the Tax Type ID to filter the order line items you want to list: Purchases Tax Sales Tax Tax Exempt

View an Order Line Item

Retrieves the details of an existing order line item.

Order Line Item ID	Select the Order Line Item ID whose details you want to retrieve.

Delete an Order Line Item

Permanently deletes an order line item. It cannot be undone. This order line item is no longer available for future sales orders.

Order Line Item ID	Select the Order Line Item ID you want to delete.

Product

Watch New Products

Triggers when a new product is created.

Limit	The maximum number of products Ibexa Connect should return during one scenario execution cycle.

Search Products

Returns a list of Products

Limit	The maximum number of products Ibexa Connect should return during one scenario execution cycle.
Created Since	Enter the date from which you want to list the products. For example, 2015-11-04T00:00:00.00Z
Created Until	Enter the date until which you want to list the products. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the products updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the products updated. For example, 2015-11-04T00:00:00.00Z
Filter by Status	Select the option to filter the products based on their status: Active Disabled
Filter by Brand	Enter the brand name to filter the products.
Filter by Product Type	Enter the product type to filter the products.
Filter by Tags	Enter the tags to filter the products.

View a Product

Retrieves the details of an existing product.

Product ID	Select the Product ID whose details you want to retrieve.

Create a New Product

Creates a new product object.

Name	Enter the name for the new product.
Brand	Enter the brand of the product.
Product Type	Enter the product type.
Description	Enter the details of the product.
Variant Option 1	Enter the customized options available in the product. For example, Size, Color, and so on.
Variant Option 2	Enter the customized options available in the product. For example, Size, Color, and so on.
Variant Option 3	Enter the customized options available in the product. For example, Size, Color, and so on.
Supplier ID	Add the Supplier ID of the supplier who supplies the product. ID Enter the Supplier ID of the product.
Tags	Add the tags that help searching or filtering the product: Tag Add keywords about the company to add a tag.

Update a Product

Updates the specified product. Any parameters not provided will be left unchanged.

Product ID	Select the Product ID you want to update.
Name	Enter the name for the new product.
Brand	Enter the brand of the product.
Product Type	Enter the product type.
Description	Enter the details of the product.
Variant Option 1	Enter the customized options available in the product. For example, Size, Color, and so on
Variant Option 2	Enter the customized options available in the product. For example, Size, Color, and so on
Variant Option 3	Enter the customized options available in the product. For example, Size, Color, and so on
Supplier ID	Add the Supplier ID of the supplier who supplies the product. ID Enter the Supplier ID of the product.
Tags	Add the tags that help searching or filtering the product: Tag Add keywords about the company to add as tag.

Delete a Product

Permanently deletes a product. It cannot be undone. This product is no longer available for the future sales orders.

Product ID	Select the Product ID you want to delete.

Purchase Order

Watch New Purchase Orders

Triggers when a new purchase order is created.

Limit	The maximum number of purchase orders Ibexa Connect should return during one scenario execution cycle.

Search Purchase Orders

Returns a list of purchase orders.

Limit	The maximum number of purchase orders Ibexa Connect should return during one scenario execution cycle
Created Since	Enter the date from which you want to list the purchase orders. For example, 2015-11-04T00:00:00.00Z
Created Uuntil	Enter the date until which you want to list the purchase orders. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the purchase orders updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the purchase orders updated. For example, 2015-11-04T00:00:00.00Z
Filter by Status	Select the option to filter the purchase orders based on their status: Active Disabled
Filter by Billing Address ID	Select the Billing Address ID of the purchase order you want to list.
Filter by Company ID	Select the Company ID of the purchase order you want to list.
Filter by Currency ID	Select the Currency ID of the purchase order you want to list.
Filter by Stock Location ID	Select the Stock Location ID of the purchase order you want to list.
Filter by Supplier Address ID	Select the Supplier Address ID of the purchase order you want to list.
Filter by Order Number	Enter the order number of the purchase order you want to list.
Filter by Tags	Enter the tags of the purchase order you want to list.

View a Purchase Order

Retrieves the details of an existing purchase order.

Purchase Orders ID	Select the Purchase Order ID whose details you want to retrieve.

Create a New Purchase Order

Creates a new purchase order object.

Company ID	Select the Company ID for which you want to create a new purchse order.
Supplier Address ID	Select the Supplier Address ID of the purchase order.
Billing Address ID	Select the Billing Address ID of the purchase order.
Stock Location ID	Select the Stock Location ID to where the stock must be delivered.
Stock Due	Enter the date by which the stock must be delivered.
Order Number	Enter the order number of the purchase order.
Currency	Select the applicable currency for the purchase order.
Reference	Enter the reference number for the purchase order.
Email Address	Enter the contact email address for the purchase order.
Totals Are	Select whether the total amount inclusive of tax: Tax Inclusive Tax Exclusive
Notes	Enter the details of the purchase order.
Status	Select the status of the purchase order: Active Draft Received
Tags	Add the tags that help searching or filtering the purchase order: Tag Add keywords about the company to add as tag.

Update a Purchase Order

Updates the specified purchase order. Any parameters not provided will be left unchanged.

Purchase Order ID	Select the Purchase Order ID you want to update.
Company ID	Select the Company ID for which you want to create a new purchse order.
Supplier Address ID	Select the Supplier Address ID of the purchase order.
Billing Address ID	Select the Billing Address ID of the purchase order.
Stock Location ID	Select the Stock Location ID to where the stock must be delivered.
Stock Due	Enter the date by which the stock must be delivered.
Order Number	Enter the order number of the purchase order.
Currency	Select the applicable currency for the purchase order.
Reference	Enter the reference number for the purchase order.
Email	Enter the contact email address for the purchase order.
Total Are	Select whether the total amount inclusive of tax: Tax Inclusive Tax Exclusive
Notes	Enter the details of the purchase order.
Status	Select the status of the purchase order: Active Draft Received
Tags	Add the tags that help searching or filtering the purchase order: Tag Add keywords about the company to add a tag.

Delete a Purchase Order

Permanently deletes a Purchase Order. It cannot be undone. This purchase order is no longer available for future sales orders.

Purchase Orders ID	Select the Purchase Order ID you want to delete.

Purchase Order Line Item

Watch New Purchase Order Line Items

Check if new purchase order line item was created.

Limit	The maximum number of purchase order line items Ibexa Connect should return during one scenario execution cycle.

Search Purchase Order Line Items

Returns a list of purchase order line items.

>

Limit	The maximum number of purchase order line items Ibexa Connect should return during one scenario execution cycle.
Created Since	Enter the date from which you want to list the purchase order line items. For example, 2015-11-04T00:00:00.00Z
Created Until	Enter the date until which you want to list the purchase order line items. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the purchase order line items updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the purchase order line items. For example, 2015-11-04T00:00:00.00Z
Filter by Variant ID	Select the Variant ID of the purchase order line item you want to list.
Filter by Tax Type ID	Select Tax Type ID of the purchase order line item you want to list: Purchases Tax Sales Tax Tax Exempt
Filter by Procurement ID	Enter the Procurement ID of the purchase order line item you want to list.

View a Purchase Order Line Item

Retrieves the details of an existing purchase order line item.

Purchase Order Line Item ID	Select the Purchase Order Line Item ID whose details you want to retrieve.

Create a New Purchase Order Line Item

Creates a new purchase order line item object.

Purchase Order ID	Select the Purchase Order ID for which you want to create the purchase order line item.
Variant ID	Select the Variant ID for the purchase order line item.
Tax Type ID	Select the Tax Type ID applicable for purchase order line items: Purchases Tax Sales Tax Tax Exempt
Price	Enter the price of the purchase order line item.
Procurement ID	Enter the Procurement ID of the purchase order line item.
Base Price	Enter the base price of the purchase order line item.
Freeform	Select Yes if this purchase order line item is a freeform.
Image URL	Enter the image path of the purchase order line item.
Label	Enter the applicable label for the purchase order line item.
Position	Enter the sequence of the purchase order line item.
Quantity	Enter the number of items.
Tax Rate Override	Enter the applicable tax rate that can be overridden for the purchase order line item.
Extra Cost Value	Enter if there is any extra cost values for the purchase order line item.

Update a Purchase Order Line Item

Updates the specified purchase order line item. Any parameters not provided will be left unchanged.

Purchase Order Line Item ID	Select the Purchase Order Line Item ID you want to update.
Purchase Order ID	Select the Purchase Order ID for which you want to create the purchase order line item.
Variant ID	Select the Variant ID for the purchase order line item.
Tax Type ID	Select the Tax Type ID applicable for purchase order line items: Purchases Tax Sales Tax Tax Exempt
Procurement ID	Enter the Procurement ID of the purchase order line item.
Base Price	Enter the base price of the purchase order line item.
Freeform	Select Yes if this purchase order line item is a freeform.
Image URL	Enter the image path of the purchase order line item.
Label	Enter the applicable label for the purchase order line item.
Position	Enter the sequence of the purchase order line item.
Price	Enter the price of the purchase order line item.
Quantity	Enter the number of items.
Tax Rate Override	Enter the applicable tax rate that can be overridden for the purchase order line item.
Extra Cost Value	Enter if there is any extra cost for the purchase order line item.

Delete a Purchase Order Line Item

Permanently deletes a purchase order line item. It cannot be undone. This purchase order line item is no longer available for future sales orders.

Purchase Order Line Item ID	Select the Purchase Order Line Item ID you want to delete.

Variant

Watch New Variants

Triggers when a new variant is created.

Limit	The maximum number of variants Ibexa Connect should return during one scenario execution cycle.

Search Variants

Returns a list of variants.

Limit	The maximum number of variants Ibexa Connect should return during one scenario execution cycle.
Created Since	Enter the date from which you want to list the variants. For example, 2015-11-04T00:00:00.00Z
Created Until	Enter the date until which you want to list the variants. For example, 2015-11-04T00:00:00.00Z
Updated Since	Enter the date from which you want to list the variants updated. For example, 2015-11-04T00:00:00.00Z
Updated Until	Enter the date until which you want to list the variants updated. For example, 2015-11-04T00:00:00.00Z
Filter by Product ID	Select the Product ID of the variant you want to list.
Filter by SKU	Enter the Stock Keeping Unit of the variant you ant to list.

View a Variant

Retrieves the details of an existing variant.

Variant ID	Select the Varaint ID whose details you want to retrieve.

Create a New Variant

Creates a new variant object.

Product ID	Select the Product ID whose variant you want to create.
Default Ledger Account ID	Enter the Default Ledger Account ID to be used for revenue integrations.
Buy Price	Enter the buying pridce of the variant.
Composite	Select Yes if this variants is a comabination of other variants: Yes No Not defined
Description	Enter the details of the variant.
Initial Cost Price	Enter the initial variant item cost price. Available only when creating the variant for the first time.
Initial Stock Level	Enter the initial available variant stock. Available only when creating the variant for the first time.
Initial stock location ID	Enter the Stock Location ID to where the variant stock to be delivered.
Keep Selling	Select if you want the variant item to be continued to sell even if there is no stock available.
Manage Stock	Select Yes if you want to manage composite variants: Yes No Not defined
Max Online	Enter the maximum stock value to be shown in the online store.
Name	Enter the name of the variant.
Online Ordering	Select Yes if the contact has access to online ordering: Yes No Not defined
Variant Option 1	Enter the customized options available in the product. For example, Size, Color, and so on.
Variant Option 2	Enter the customized options available in the product. For example, Size, Color, and so on.
Variant Option 3	Enter the customized options available in the product. For example, Size, Color, and so on.
Position	Enter the sequence of the purchase order line item.
Retail Price	Enter the recommended retail price of the variant.
Sellable	Select Yes if the variant item can be added to the sales orders: Yes No Not defined
SKU	Enter the stock keeping unit value of the variant.
Supplier Code	Enter the supplier code of the variant.
Taxable	Select Yes if the varaint is taxable: Yes No Not defined
UPC	Enter the UPC number of the varaint.
Weight Value	Enter the weight of the varinat item.
Weight Unit	Enter measurement unit of the variant item.
Wholesale Price	Enter the wholesale price of the variant item.

Update a Variant

Updates the specified variant by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Variant ID	Select the Variant ID.
Product ID	Select the Product ID whose variant you want to create.
Default Ledger Account ID	Enter the Default Ledger Account ID to be used for revenue integrations.
Buy Price	Enter the buying pridce of the variant.
Composite	Select Yes if this variants is a comabination of other variants: Yes No Not defined
Description	Enter the details of the variant.
Initial Cost Price	Enter the initial variant item cost price. Available only when creating the variant for the first time.
Initial Stock Level	Enter the initial available variant stock. Available only when creating the variant for the first time.
Initial Stock Location ID	Enter the Stock Location ID to where the variant stock to be delivered.
Keep Selling?	Select if you want the variant item to be continued to sell even if there is no stock available.
Manage Stock	Select Yes if you want to manage composite variants: Yes No Not defined
Max Online	Enter the maximum stock value to be shown in the online store.
Name	Enter the name of the variant.
Online Ordering	Select Yes if the contact has access to online ordering: Yes No Not defined
Variant Option 1	Enter the customized options available in the product. For example, Size, Color, and so on.
Variant Option 2	Enter the customized options available in the product. For example, Size, Color, and so on.
Variant Option 3	Enter the customized options available in the product. For example, Size, Color, and so on.
Position	Enter the sequence of the purchase order line item.
Retail Price	Enter the recommended retail price of the variant.
Sellable	Select Yes if the variant item can be added to the sales orders: Yes No Not defined
SKU	Enter the stock keeping unit value of the variant.
Supplier Code	Enter the supplier code of the variant.
Taxable	Select Yes if the variant is taxable: Yes No Not defined
UPC	Enter the UPC number of the variant.
Weight Value	Enter the weight of the variant item.
Weight Unit	Enter the measurement unit of the variant item.
Wholesale Price	Enter the wholesale price of the variant item.

Delete a Variant

Permanently deletes a variant. It cannot be undone. This variant is no longer available for future sales orders.

Variant ID	Select the Variant ID you want to delete.

Other

Make an API Call

Allows you to perform a custom API call.

URL

Enter a path relative to https://api.tradegecko.com. E.g. /contacts

For the list of available endpoints, refer to the TradeGecko API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Contacts

The following API call returns the contacts from your TradeGecko account:

URL: /contacts

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body > contacts. In our example, 5 contacts were returned: